Skip to content

Commit 970b120

Browse files
committed
deleted all files and replaced with build a sat files
1 parent f1ec75f commit 970b120

523 files changed

Lines changed: 192989 additions & 4405 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

0 Bytes
Binary file not shown.

.github/dependabot.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: bundler
4+
directory: /
5+
schedule:
6+
interval: daily
7+
allow:
8+
- dependency-type: direct

.github/workflows/ci.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
pull_request:
7+
branches: ["main"]
8+
9+
jobs:
10+
# Build job
11+
build:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
- name: Setup Ruby
17+
uses: ruby/setup-ruby@v1
18+
with:
19+
ruby-version: '3.3' # Not needed with a .ruby-version file
20+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
21+
cache-version: 0 # Increment this number if you need to re-download cached gems
22+
- name: Build with Jekyll
23+
run: bundle exec jekyll build

.github/workflows/pages.yml

Lines changed: 58 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,62 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
15

2-
# Set the default working-directory param for the build job.
3-
build:
4-
runs-on: ubuntu-latest
5-
defaults:
6-
run:
7-
working-directory: docs
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
88

9-
# Set the working-directory param for the Setup Ruby step.
10-
- name: Setup Ruby
11-
uses: ruby/setup-ruby@v1
12-
with:
13-
ruby-version: '3.1'
14-
bundler-cache: true
15-
cache-version: 0
16-
working-directory: '${{ github.workspace }}/docs'
17-
18-
# Set the path param for the Upload artifact step:
19-
- name: Upload artifact
20-
uses: actions/upload-pages-artifact@v1
21-
with:
22-
path: "docs/_site/"
23-
24-
# Modify the trigger so that only changes within the docs directory start the workflow.
25-
# Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy.
269
on:
2710
push:
28-
branches:
29-
- "main"
30-
paths:
31-
- "docs/**"
11+
branches: ["main"]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow one concurrent deployment
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: true
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- name: Setup Ruby
35+
uses: ruby/setup-ruby@v1
36+
with:
37+
ruby-version: '3.3' # Not needed with a .ruby-version file
38+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
39+
cache-version: 0 # Increment this number if you need to re-download cached gems
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v5
43+
- name: Build with Jekyll
44+
# Outputs to the './_site' directory by default
45+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
46+
env:
47+
JEKYLL_ENV: production
48+
- name: Upload artifact
49+
# Automatically uploads an artifact from the './_site' directory by default
50+
uses: actions/upload-pages-artifact@v3
51+
52+
# Deployment job
53+
deploy:
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
runs-on: ubuntu-latest
58+
needs: build
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
13

2-
*.pdf
3-
# Commiting contents of _site for themes
4-
# _site
5-
_site/404.html
6-
_site/about/
7-
_site/assets/
8-
_site/feed.xml
9-
_site/github/
10-
_site/index.html
11-
_site/jekyll/
12-
_site/gh-pages/
13-
.sass-cache
14-
.jekyll-cache
15-
.jekyll-metadata
4+
# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/

Gemfile

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
source "https://rubygems.org"
1+
source 'https://rubygems.org'
22

3-
git_source(:github) {|repo_name| "https://github.com/BIRDSOpenSource/BIRDSOpenSource.github.io" }
4-
5-
gem 'jekyll-theme-minimal'
3+
gem "jekyll", "~> 4.3.2" # installed by `gem jekyll`
4+
gem "just-the-docs", "0.5.4" # pinned to the current release
5+
# gem "just-the-docs" # always download the latest release
66

77
group :jekyll_plugins do
8-
gem "jekyll-sitemap"
9-
gem "jekyll-seo-tag"
8+
gem "jekyll-polyglot"
9+
gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
10+
gem "base64", "~> 0.2.0"
1011
end

Gemfile.lock

Lines changed: 0 additions & 117 deletions
This file was deleted.

LICENSE.md renamed to LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) [2024] [The BIRDS Project]
3+
Copyright (c) 2022 just-the-docs
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,75 @@
1-
# Some info just to test
1+
# BIRDS Build-A-Satellite Documentation Site
22

3-
* Some stuff
3+
Welcome to the BIRDS Build-A-Satellite Documentation Site! This platform provides a comprehensive guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our documentation is structured to assist you at every stage of the satellite development process.
4+
5+
## About the Project
6+
7+
BIRDS-OSP is dedicated to empowering individuals, research groups, and educational institutions with limited resources to embark on satellite missions. This documentation is designed for those aiming to understand and develop a satellite from the ground up, focusing on open-source tools and affordable methods for accessible satellite technology.
8+
9+
### Key Features
10+
11+
- **Step-by-Step Guides**: Detailed instructions covering each phase, from concept design to in-orbit operation.
12+
- **Hardware and Software Specifications**: Comprehensive information on components, materials, software, and libraries.
13+
- **Code Repositories**: Links to essential open-source codebases and development tools.
14+
- **Troubleshooting and FAQ**: Solutions to common issues and tips for overcoming challenges.
15+
- **Community Support**: Join our community to get advice, share experiences, and collaborate with other developers.
16+
17+
## Getting Started
18+
19+
### Prerequisites
20+
21+
Before diving in, make sure you have the following:
22+
23+
- Basic knowledge of electronics and programming.
24+
- Access to [List of Required Tools and Software, e.g., CAD software, programming languages].
25+
- Familiarity with Git and GitHub for accessing project repositories.
26+
27+
### Setting Up
28+
29+
1. **Clone the Repository**: Download the documentation repository to get started.
30+
```bash
31+
git clone https://github.com/your-repo/satellite-docs.git
32+
```
33+
2. **Navigate the Site**: Explore our structured guides:
34+
- [Design & Planning](#)
35+
- [Component Selection](#)
36+
- [Assembly & Testing](#)
37+
- [Launch Preparations](#)
38+
39+
3. **Join the Community**: Connect with other developers and contributors in our [Forum/Discord/Slack Channel].
40+
41+
## Contributing
42+
43+
We welcome contributions! Here’s how you can help:
44+
45+
1. **Improve Documentation**: Submit updates to enhance clarity, correct errors, or add new sections.
46+
2. **Suggest Features**: Share your ideas to improve the documentation or add resources.
47+
3. **Report Issues**: Encountered a problem? Submit an issue on our GitHub page.
48+
49+
### Contribution Guidelines
50+
51+
Please refer to our [Contribution Guide](#) for more details on coding standards, branch naming conventions, and testing requirements.
52+
53+
## Contact
54+
55+
For questions, suggestions, or support, reach out to our team at [contact@projectemail.com](mailto:contact@projectemail.com) or join the [Community Forum](#).
56+
57+
58+
## Licensing and Attribution
59+
60+
This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
61+
62+
63+
----
64+
65+
[Jekyll]: https://jekyllrb.com
66+
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
67+
[GitHub Pages]: https://docs.github.com/en/pages
68+
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
69+
[Bundler]: https://bundler.io
70+
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
71+
[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
72+
[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
73+
[MIT License]: https://en.wikipedia.org/wiki/MIT_License
74+
[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
75+
[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE

0 commit comments

Comments
 (0)