From e578cf44268954a3119a8b0c4f940d46f2200c2e Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 18:28:05 +0900 Subject: [PATCH 1/9] added taglline to title and altered decription, added email to config file --- _config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_config.yml b/_config.yml index 08c65ef..cd6095d 100644 --- a/_config.yml +++ b/_config.yml @@ -1,8 +1,8 @@ # site settings -title: BIRDS | Open Source Release -description: The BIRDS Open Source Release is a comprehensive open source 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. -email: null +title: BIRDS | An Open Source Bus System for Academic Satellites +description: The BIRDS Open Source Release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process. +email: birds_opensource@lean-sat.org # theme From a84fd9857d964a788e432c35329beff94a0496fb Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 18:36:17 +0900 Subject: [PATCH 2/9] added email dynamically --- README.md | 2 +- _site/about/index.html | 2 +- _site/index.html | 2 +- gsoc/application-guide.md | 2 +- gsoc/index.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a3c1d3a..72ad673 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Please refer to our [Contribution Guide](#) for more details on coding standards ## Contact -For questions, suggestions, or support, reach out to our team at [contact@projectemail.com](mailto:contact@projectemail.com) or join the [Community Forum](#). +For questions, suggestions, or support, reach out to our team at [{{site.email}}]({{site.email}}) or join the [Community Forum](#). ## Licensing and Attribution diff --git a/_site/about/index.html b/_site/about/index.html index 9af533a..3058ee4 100644 --- a/_site/about/index.html +++ b/_site/about/index.html @@ -1 +1 @@ - BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 11, 2025 BIRDS | Open Source Release

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

+ BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDS | Open Source Release

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

diff --git a/_site/index.html b/_site/index.html index 938c661..760739d 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1 +1 @@ - BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 11, 2025 BIRDS | Open Source Release

A learning guide

Everything you need to build a satellite: A step-by-step guide

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Space for All

Learn the basics of the BIRDS Bus, the platform's architecture, and what problems the BIRDS Bus can solve for your team START
Choose your path

Learn how to set up and integrate the satellite bus based on your level of experience. Novice, hobbyist, or expert.
START
Adapting Software

Learn how to add your team's software components to the firmware with the Software Templates START



+ BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDS | Open Source Release

A learning guide

Everything you need to build a satellite: A step-by-step guide

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Space for All

Learn the basics of the BIRDS Bus, the platform's architecture, and what problems the BIRDS Bus can solve for your team START
Choose your path

Learn how to set up and integrate the satellite bus based on your level of experience. Novice, hobbyist, or expert.
START
Adapting Software

Learn how to add your team's software components to the firmware with the Software Templates START



diff --git a/gsoc/application-guide.md b/gsoc/application-guide.md index 7d04f9e..c942f69 100644 --- a/gsoc/application-guide.md +++ b/gsoc/application-guide.md @@ -82,6 +82,6 @@ A great GSoC proposal should: 📨 **Need Help? [Contact Us!](https://t.me/+D3BCqCmceQ41ZGFl)** 📌 **GitHub Discussions:** [BIRDS Open Source](https://github.com/orgs/BIRDSOpenSource/discussions) -📌 **Email:** birds_opensource@lean-sat.org +📌 **Email:** {{site.email}} 🚀 **We look forward to your application! Good luck!** diff --git a/gsoc/index.md b/gsoc/index.md index c5c2e88..1f5c877 100644 --- a/gsoc/index.md +++ b/gsoc/index.md @@ -58,7 +58,7 @@ Have questions? We're happy to help! 📌 **Join Our Community:** Slack (coming soon) / [Forum Link](https://lean-sat.org/opensource/)
📌 **Email Us:** birds_opensource@lean-sat.org
-📌 **GitHub:** [BIRDS Open Source](https://github.com/BIRDSOpenSource)
+📌 **GitHub:** [BIRDS Open Source]({{site.email}})
--- From c5b202c13fb96bd6477c137259fd0f77276a7a6a Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 18:38:48 +0900 Subject: [PATCH 3/9] added telegram --- gsoc/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/gsoc/index.md b/gsoc/index.md index 1f5c877..3bc0cb9 100644 --- a/gsoc/index.md +++ b/gsoc/index.md @@ -56,9 +56,9 @@ BIRDS Open Source is a **collaborative CubeSat development community** that emer ## 📩 Get in Touch! Have questions? We're happy to help! -📌 **Join Our Community:** Slack (coming soon) / [Forum Link](https://lean-sat.org/opensource/)
-📌 **Email Us:** birds_opensource@lean-sat.org
-📌 **GitHub:** [BIRDS Open Source]({{site.email}})
+📌 **Join Our Community:** [Telegram](https://t.me/+zxcJw7vGbi1lNGY9) / [Forum Link](https://lean-sat.org/opensource/)
+📌 **Email Us:** {{site.email}}
+📌 **GitHub:** [BIRDS Open Source](https://github.com/BIRDSOpenSource)
--- From 0ae4b03c4e736e31702940825d8755020b30b533 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 18:44:06 +0900 Subject: [PATCH 4/9] added variables in config for external sites --- Gemfile.lock | 2 +- _config.yml | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 1ea0b1b..56db67c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -79,7 +79,7 @@ GEM listen (3.9.0) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) - logger (1.6.5) + logger (1.6.6) mercenary (0.4.0) net-http (0.6.0) uri diff --git a/_config.yml b/_config.yml index cd6095d..04cfe9b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,8 +1,12 @@ # site settings -title: BIRDS | An Open Source Bus System for Academic Satellites +title: BIRDSOpenSource | An Open Source Bus System for Academic Satellites description: The BIRDS Open Source Release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process. email: birds_opensource@lean-sat.org +telegram: https://t.me/+D3BCqCmceQ41ZGFl +mailing_list: https://lean-sat.org/opensource/ +youtube: https://www.youtube.com/@kyutechseic4187 +github_org: https://github.com/BIRDSOpenSource # theme From 8b67dfde6fa1af6fa41135c5eaa9da4be86c49ca Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 18:49:25 +0900 Subject: [PATCH 5/9] updated config using variables --- _config.yml | 8 ++++---- gsoc/application-guide.md | 2 +- gsoc/index.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/_config.yml b/_config.yml index 04cfe9b..3ba55bf 100644 --- a/_config.yml +++ b/_config.yml @@ -72,7 +72,7 @@ heading_anchors: true # Aux links for the upper right navigation aux_links: "BIRDS-OSP on GitHub": - - "https://github.com/BIRDSOpenSource" + - "{{site.github_org}}" # Makes Aux links open in a new tab. Default is false aux_links_new_tab: true @@ -93,9 +93,9 @@ Contribute to Docs
- Learn more about how to get involved.
- Submit feedback to let us know how we can improve BIRDS Docs.

Join the Community
-- Chat With Us On Telegram
-- Watch Us On YouTube
-- Join Our Monthly Webinars" +- Chat With Us On Telegram
+- Watch Us On YouTube
+- Join Our Monthly Webinars" # Footer last edited timestamp last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter diff --git a/gsoc/application-guide.md b/gsoc/application-guide.md index c942f69..9074d4d 100644 --- a/gsoc/application-guide.md +++ b/gsoc/application-guide.md @@ -80,7 +80,7 @@ A great GSoC proposal should: 📌 **Submit Early** – Avoid last-minute issues! 📌 **Follow Up** – Stay engaged and show your enthusiasm -📨 **Need Help? [Contact Us!](https://t.me/+D3BCqCmceQ41ZGFl)** +📨 **Need Help? [Contact Us!]({{site.telegram}})** 📌 **GitHub Discussions:** [BIRDS Open Source](https://github.com/orgs/BIRDSOpenSource/discussions) 📌 **Email:** {{site.email}} diff --git a/gsoc/index.md b/gsoc/index.md index 3bc0cb9..1b834ee 100644 --- a/gsoc/index.md +++ b/gsoc/index.md @@ -56,9 +56,9 @@ BIRDS Open Source is a **collaborative CubeSat development community** that emer ## 📩 Get in Touch! Have questions? We're happy to help! -📌 **Join Our Community:** [Telegram](https://t.me/+zxcJw7vGbi1lNGY9) / [Forum Link](https://lean-sat.org/opensource/)
+📌 **Join Our Community:** [Telegram]({{site.telegram}}) / [Forum Link]({{site.mailing_list}})
📌 **Email Us:** {{site.email}}
-📌 **GitHub:** [BIRDS Open Source](https://github.com/BIRDSOpenSource)
+📌 **GitHub:** [BIRDS Open Source]({{site.github_org}})
--- From 9534ee09533219436a0eb5646e11e4890dcc403f Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 19:02:11 +0900 Subject: [PATCH 6/9] updated index removed toc --- gsoc/index.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/gsoc/index.md b/gsoc/index.md index 1b834ee..d7b113d 100644 --- a/gsoc/index.md +++ b/gsoc/index.md @@ -2,6 +2,7 @@ title: GSoC nav_order: 1 has_children: true +has_toc: false layout: default permalink: "/gsoc" lang: en @@ -53,14 +54,5 @@ BIRDS Open Source is a **collaborative CubeSat development community** that emer --- -## 📩 Get in Touch! -Have questions? We're happy to help! - -📌 **Join Our Community:** [Telegram]({{site.telegram}}) / [Forum Link]({{site.mailing_list}})
-📌 **Email Us:** {{site.email}}
-📌 **GitHub:** [BIRDS Open Source]({{site.github_org}})
- - ---- - -🚀 **Ready to launch your open-source journey?** **Join us for GSoC 2025 and help shape the future of CubeSat development!** +## [📩 Get in Touch!](mailto:{{site.email}}) +Have questions? We're happy to help! \ No newline at end of file From 823b96906b6a0c37ebd7a71d27f0e2da878f9182 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 19:28:35 +0900 Subject: [PATCH 7/9] chnaged title --- _config.yml | 5 +++-- _data/en/l10n.yml | 2 +- _site/about/index.html | 2 +- _site/index.html | 2 +- overview/index.en.md | 47 ++++++++++++++++++++++++++++++------------ 5 files changed, 40 insertions(+), 18 deletions(-) diff --git a/_config.yml b/_config.yml index 3ba55bf..efe08c1 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,8 @@ # site settings -title: BIRDSOpenSource | An Open Source Bus System for Academic Satellites -description: The BIRDS Open Source Release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process. +title: BIRDSOpenSource | Docs +tagline: An Open Source Bus System for Academic Satellites +description: The BIRDSOpenSource release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process. email: birds_opensource@lean-sat.org telegram: https://t.me/+D3BCqCmceQ41ZGFl mailing_list: https://lean-sat.org/opensource/ diff --git a/_data/en/l10n.yml b/_data/en/l10n.yml index af5aa33..4c8de5a 100644 --- a/_data/en/l10n.yml +++ b/_data/en/l10n.yml @@ -1,3 +1,3 @@ lang_name: "English" -title: BIRDS | Open Source Release +title: BIRDSOpenSource | Docs date_format: "%b %e, %Y" \ No newline at end of file diff --git a/_site/about/index.html b/_site/about/index.html index 3058ee4..a056860 100644 --- a/_site/about/index.html +++ b/_site/about/index.html @@ -1 +1 @@ - BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDS | Open Source Release

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

+ BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

diff --git a/_site/index.html b/_site/index.html index 760739d..54125c4 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1 +1 @@ - BIRDS | Open Source Release Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDS | Open Source Release

A learning guide

Everything you need to build a satellite: A step-by-step guide

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Space for All

Learn the basics of the BIRDS Bus, the platform's architecture, and what problems the BIRDS Bus can solve for your team START
Choose your path

Learn how to set up and integrate the satellite bus based on your level of experience. Novice, hobbyist, or expert.
START
Adapting Software

Learn how to add your team's software components to the firmware with the Software Templates START



+ BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

BIRDS | An Open Source Bus System for Academic Satellites

Everything you need to build a satellite

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Getting Started

New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides
User Hardware Guide

The user hardware guide provides in-depth information on the key concepts of astropy with useful background information and explanation.
to the user hardware guide
User Software Guide

Learn how to add your team's software components to the firmware with the Software Templates to the user software guide
Contributor’s Guide

Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. to the contributor's guide
Project Details

What’s new in the latest release, changelog, and other project details. to the project details



diff --git a/overview/index.en.md b/overview/index.en.md index 775b787..4512c84 100644 --- a/overview/index.en.md +++ b/overview/index.en.md @@ -9,9 +9,9 @@ lang: en has_toc: false --- -### **A learning guide** +### **{{site.title}}** {: .lh-0 .text-purple-200} -# Everything you need to build a satellite: A step-by-step guide +# Everything you need to build a satellite This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works. @@ -22,33 +22,54 @@ If you're new here, here's a list of what to expect in the next few pages:
-
- Space for All +
+ Getting Started

- Learn the basics of the BIRDS Bus, the platform's architecture, and what problems the BIRDS Bus can solve for your team + New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. - START + go to getting started guides
-
- Choose your path +
+ User Hardware Guide

- Learn how to set up and integrate the satellite bus based on your level of experience. Novice, hobbyist, or expert. + The user hardware guide provides in-depth information on the key concepts of astropy with useful background information and explanation. +
- START + to the user hardware guide
-
- Adapting Software +
+ User Software Guide

Learn how to add your team's software components to the firmware with the Software Templates - START + to the user software guide + +
+ +
+ Contributor’s Guide +

+ Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. + + + to the contributor's guide + +
+ +
+ Project Details +

+ What’s new in the latest release, changelog, and other project details. + + + to the project details
From 12a93faaea3767356a4b2a87853cc2b42b9f7cf6 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 19:56:19 +0900 Subject: [PATCH 8/9] updated homepage --- _site/index.html | 2 +- overview/index.en.md | 49 ++++++++++++++++++++++---------------------- 2 files changed, 25 insertions(+), 26 deletions(-) diff --git a/_site/index.html b/_site/index.html index 54125c4..e106ac1 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1 +1 @@ - BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

BIRDS | An Open Source Bus System for Academic Satellites

Everything you need to build a satellite

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Getting Started

New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides
User Hardware Guide

The user hardware guide provides in-depth information on the key concepts of astropy with useful background information and explanation.
to the user hardware guide
User Software Guide

Learn how to add your team's software components to the firmware with the Software Templates to the user software guide
Contributor’s Guide

Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. to the contributor's guide
Project Details

What’s new in the latest release, changelog, and other project details. to the project details



+ BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

**

Everything you need to build a satellite

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Getting Started
New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides
Hardware Guide
The user hardware guide provides in-depth information on the key concepts of the physical components in the BIRDS bus with useful background information and explanation.
to the user hardware guide
Software Guide
The user software guide provides in-depth information on the key concepts of the BIRDS bus software with useful background information and explanation. to the user software guide
Contributor’s Guide
Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. to the contributor's guide
Project Details
What’s new in the latest release, changelog, and other project details. to the project details
diff --git a/overview/index.en.md b/overview/index.en.md index 4512c84..70957ff 100644 --- a/overview/index.en.md +++ b/overview/index.en.md @@ -6,10 +6,9 @@ has_children: true has_toc: false permalink: "/" lang: en -has_toc: false --- -### **{{site.title}}** +### **{{site.tagline}}** {: .lh-0 .text-purple-200} # Everything you need to build a satellite @@ -23,8 +22,10 @@ If you're new here, here's a list of what to expect in the next few pages:
- Getting Started -

+ + + Getting Started +
New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides @@ -33,11 +34,13 @@ If you're new here, here's a list of what to expect in the next few pages:
- User Hardware Guide -

- The user hardware guide provides in-depth information on the key concepts of astropy with useful background information and explanation. + + + Hardware Guide +
+ The user hardware guide provides in-depth information on the key concepts of the physical components in the BIRDS bus with useful background information and explanation. -
+
to the user hardware guide @@ -45,17 +48,21 @@ If you're new here, here's a list of what to expect in the next few pages:
- User Software Guide -

- Learn how to add your team's software components to the firmware with the Software Templates + + + Software Guide +
+ The user software guide provides in-depth information on the key concepts of the BIRDS bus software with useful background information and explanation. to the user software guide
- Contributor’s Guide -

+ + + Contributor’s Guide +
Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. @@ -64,8 +71,10 @@ If you're new here, here's a list of what to expect in the next few pages:
- -
-
- -
- -
- - -[click here]: https://lean-sat.org/opensource/ From 53b012258c6b67d021a630a0069a38518888cdd8 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Thu, 13 Feb 2025 23:38:53 +0900 Subject: [PATCH 9/9] changed aux link name, --- README.md | 2 +- _config.yml | 2 +- {overview/birds => _resources}/teams.md | 0 _site/about/index.html | 2 +- _site/index.html | 2 +- get-started.md | 49 ------------------- .../birds/GS-software.md | 2 +- .../birds/antenna-page.md | 2 +- .../birds/bpb-page.md | 2 +- .../birds/bus-page.md | 2 +- .../birds/com-page.md | 2 +- .../birds/fab-page.md | 2 +- {overview => getting-started}/birds/index.md | 2 +- .../birds/obc-page.md | 2 +- .../birds/rab-page.md | 2 +- .../birds/solar-page.md | 2 +- .../index.md | 14 ++++-- gsoc/index.md | 2 +- overview/index.en.md => index.en.md | 19 ++++--- overview/index.jp.md => index.jp.md | 0 20 files changed, 34 insertions(+), 78 deletions(-) rename {overview/birds => _resources}/teams.md (100%) delete mode 100644 get-started.md rename {overview => getting-started}/birds/GS-software.md (95%) rename {overview => getting-started}/birds/antenna-page.md (96%) rename {overview => getting-started}/birds/bpb-page.md (99%) rename {overview => getting-started}/birds/bus-page.md (99%) rename {overview => getting-started}/birds/com-page.md (99%) rename {overview => getting-started}/birds/fab-page.md (97%) rename {overview => getting-started}/birds/index.md (99%) rename {overview => getting-started}/birds/obc-page.md (99%) rename {overview => getting-started}/birds/rab-page.md (95%) rename {overview => getting-started}/birds/solar-page.md (96%) rename overview/before-you-start.md => getting-started/index.md (94%) rename overview/index.en.md => index.en.md (82%) rename overview/index.jp.md => index.jp.md (100%) diff --git a/README.md b/README.md index 72ad673..48134d5 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ## About the Project -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. +BIRDSOpenSource 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. ### Key Features diff --git a/_config.yml b/_config.yml index efe08c1..884cb2c 100644 --- a/_config.yml +++ b/_config.yml @@ -72,7 +72,7 @@ heading_anchors: true # Aux links for the upper right navigation aux_links: - "BIRDS-OSP on GitHub": + "BIRDSOpenSource on GitHub": - "{{site.github_org}}" # Makes Aux links open in a new tab. Default is false diff --git a/overview/birds/teams.md b/_resources/teams.md similarity index 100% rename from overview/birds/teams.md rename to _resources/teams.md diff --git a/_site/about/index.html b/_site/about/index.html index a056860..b7d7a31 100644 --- a/_site/about/index.html +++ b/_site/about/index.html @@ -1 +1 @@ - BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

+ BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

BIRDS Open Source: Begin your satellite development

BIRDS Open Source offers a library of resources to guide your satellite mission from start to finish, with workflows and open-source tools you can trust.

The BIRDS Open Source includes the following:

  • Software Catalog: Allows you to manage all your software in one place including microservices, libraries and data pipelines.
  • Software Templates: Quickly start projects and standardize tools with best practices
  • TechDocs: Easily create and maintain technical documentation using a “docs like code” approach

Benefits of the BIRDS Open Source

  • For engineering managers: It simplifies the process of maintaining standards and managing your interconnected tech network.
  • For developers: The BIRDS Open Source provides a central place to manage all projects, which ease the building of standardized software components.
  • For platform engineers: It allows for seamless integration of new tools and extends functionality.
  • For Everyone: It serves as a single and consistent experience that ties all your resources and tools together.

Explore the BIRDS Series

The original BIRDS logo

The Joint Global Multi-Nations Birds Satellite project, or BIRDS project for short, was established by the Kyushu Institute of Technology (Kyutech) to help countries build their first satellite. Young engineers from select countries get to learn about space engineering at Kyutech, mostly using the 1U CubeSat.

The BIRDS project has two main objectives:

  1. Experience the entire cycle of a satellite project, from mission definition to operation, in a hands-on manner.
  2. Have a strategy for sustainability after the training.

The primary goal is not to build a satellite, but to establish a sustainable space program in each member country.

So far, there have been 4 completed and one ongoing BIRDS missions, which are:

  1. BIRDS-1: Bangladesh, Japan, Mongolia, Ghana and Nigeria .
  2. BIRDS-2: Bhutan, Philippines and Malaysia.
  3. BIRDS-3: Japan, Sri Lanka and Nepal.
  4. BIRDS-4: Japan, Philippines and Paraguay.
  5. BIRDS-5: Japan, Uganda and Zimbabwe.

Kyutech’s fellowship programs (PNST) and Space Engineering International Course (SEIC) provide hands-on space engineering training using CubeSat development, enabling each mission to be completed in two years. The goal of open sourcing the process is to enable teams from across the world to develop their own countries’ first satellites.

Documentation Team

This documentation has been developed and managed by various team members of Kyutech BIRDS program. Find out more here.

Next Page: More on BIRDS Bus Go To: Get Started Now

diff --git a/_site/index.html b/_site/index.html index e106ac1..d2277b3 100644 --- a/_site/index.html +++ b/_site/index.html @@ -1 +1 @@ - BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

**

Everything you need to build a satellite

This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works.

If you’re new here, here’s a list of what to expect in the next few pages:

  • Introduction to the Birds bus and other core components
  • How to get started
  • Deep dives on technical topics
Getting Started
New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides
Hardware Guide
The user hardware guide provides in-depth information on the key concepts of the physical components in the BIRDS bus with useful background information and explanation.
to the user hardware guide
Software Guide
The user software guide provides in-depth information on the key concepts of the BIRDS bus software with useful background information and explanation. to the user software guide
Contributor’s Guide
Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. to the contributor's guide
Project Details
What’s new in the latest release, changelog, and other project details. to the project details
+ BIRDSOpenSource | Docs Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Powered by: BIRDS Project, and is distributed by the MIT License.
Feb 13, 2025 BIRDSOpenSource | Docs

An Open Source Bus System for Academic Satellites

Everything you need to build a satellite

The BIRDSOpenSource release is a comprehensive open source guide for designing, building, testing, and launching a small satellite. Whether you’re a beginner or an experienced developer, our resources are structured to assist you at every stage of the satellite development process.

Here’s what you can expect:

  • Introduction to the BIRDS bus and other core components
  • How to get started
  • Deep dives on technical topics
Getting Started
New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. go to getting started guides
Hardware Guide
The user hardware guide provides in-depth information on the key concepts of the physical components in the BIRDS bus with useful background information and explanation.
to the user hardware guide
Software Guide
The user software guide provides in-depth information on the key concepts of the BIRDS bus software with useful background information and explanation. to the user software guide
Contributor’s Guide
Saw a typo in the documentation? Want to improve existing functionalities? The contributing guidelines will guide you through the process of improving BIRDSOpenSource. to the contributor's guide
Project Details
What’s new in the latest release, changelog, and other project details. to the project details
diff --git a/get-started.md b/get-started.md deleted file mode 100644 index cbd9309..0000000 --- a/get-started.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Start your journey -nav_order: 3 -layout: default -permalink: "/get-started" -lang: en ---- - -# Get Started -Build-A-Sat makes satellite creation seamless. Import your application by linking your Git repository to preserve and deploy your codebase easily. You can also start from scratch or use professional templates to build your CubeSat. ---- -# How will you start? -Choose your path and begin building your CubeSat with BIRDS today: - - -[ I'm starting from scratch]({{site.url}}/how-tos/define-mission-specs){: .btn .btn-outline .text-grey-lt-000 .bg-grey-dk-100} - - -[ I have technical experience]({{site.url}}/pm/guide){: .btn .btn-outline .text-grey-dk-300} - - -[ I've built a satellite before]({{site.url}}/pm/guide){: .btn .btn-outline .text-grey-dk-300} - - ---- - -## Basics -Start with the **basic guides** to understand core concepts like onboard computers, mission creation, link budgets, and mission testing. - -Use professional templates to quickly launch your project, perfect for starting a new application with a solid foundation. - - -[
Project Management]({{site.url}}/pm/guide){: .btn .btn-outline .text-grey-dk-300 .bg-grey-lt-000} - - - -[
Command & Data Handling]({{site.url}}/obc/guide){: .btn .btn-outline .text-grey-dk-300 .bg-grey-lt-000} - - - -[
Communication]({{site.url}}/com/guide){: .btn .btn-outline .text-grey-dk-300 .bg-grey-lt-000} - - - -[
Backplane Integration]({{site.url}}/bpb/guide){: .btn .btn-outline .text-grey-dk-300 .bg-grey-lt-000} - - -[Previous]({{site.url}}/get-started){: .btn .btn-purple } -[Next]({{site.url}}/get-started/reference.html){: .btn} diff --git a/overview/birds/GS-software.md b/getting-started/birds/GS-software.md similarity index 95% rename from overview/birds/GS-software.md rename to getting-started/birds/GS-software.md index 9fbb612..739205e 100644 --- a/overview/birds/GS-software.md +++ b/getting-started/birds/GS-software.md @@ -1,7 +1,7 @@ --- title: GS-Software parent: What is BIRDS? -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/antenna-page.md b/getting-started/birds/antenna-page.md similarity index 96% rename from overview/birds/antenna-page.md rename to getting-started/birds/antenna-page.md index 3e71abb..424f5fb 100644 --- a/overview/birds/antenna-page.md +++ b/getting-started/birds/antenna-page.md @@ -1,7 +1,7 @@ --- title: Antenna Board parent: What is BIRDS? -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/bpb-page.md b/getting-started/birds/bpb-page.md similarity index 99% rename from overview/birds/bpb-page.md rename to getting-started/birds/bpb-page.md index dc2009f..05f718f 100644 --- a/overview/birds/bpb-page.md +++ b/getting-started/birds/bpb-page.md @@ -2,7 +2,7 @@ title: Backplane Board parent: What is BIRDS? nav_order: 4 -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/bus-page.md b/getting-started/birds/bus-page.md similarity index 99% rename from overview/birds/bus-page.md rename to getting-started/birds/bus-page.md index d5eb4f4..76be111 100644 --- a/overview/birds/bus-page.md +++ b/getting-started/birds/bus-page.md @@ -2,7 +2,7 @@ title: BIRDS Bus parent: What is BIRDS? nav_order: 1 -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/com-page.md b/getting-started/birds/com-page.md similarity index 99% rename from overview/birds/com-page.md rename to getting-started/birds/com-page.md index 1897486..681b5c4 100644 --- a/overview/birds/com-page.md +++ b/getting-started/birds/com-page.md @@ -2,7 +2,7 @@ title: Communications Board parent: What is BIRDS? nav_order: 3 -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/fab-page.md b/getting-started/birds/fab-page.md similarity index 97% rename from overview/birds/fab-page.md rename to getting-started/birds/fab-page.md index d0b18d8..39b2319 100644 --- a/overview/birds/fab-page.md +++ b/getting-started/birds/fab-page.md @@ -2,7 +2,7 @@ title: Front Access Board parent: What is BIRDS? nav_order: 5 -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/index.md b/getting-started/birds/index.md similarity index 99% rename from overview/birds/index.md rename to getting-started/birds/index.md index d21f46b..582c2a2 100644 --- a/overview/birds/index.md +++ b/getting-started/birds/index.md @@ -1,7 +1,7 @@ --- title: What is BIRDS? nav_order: 1 -parent: Home +parent: Getting Started has_children: true has_toc: false layout: default diff --git a/overview/birds/obc-page.md b/getting-started/birds/obc-page.md similarity index 99% rename from overview/birds/obc-page.md rename to getting-started/birds/obc-page.md index 770fc27..72535f1 100644 --- a/overview/birds/obc-page.md +++ b/getting-started/birds/obc-page.md @@ -2,7 +2,7 @@ title: On Board Computer Board parent: What is BIRDS? nav_order: 2 -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/rab-page.md b/getting-started/birds/rab-page.md similarity index 95% rename from overview/birds/rab-page.md rename to getting-started/birds/rab-page.md index 086063b..eea3987 100644 --- a/overview/birds/rab-page.md +++ b/getting-started/birds/rab-page.md @@ -1,7 +1,7 @@ --- title: Rear Access Board parent: What is BIRDS? -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/birds/solar-page.md b/getting-started/birds/solar-page.md similarity index 96% rename from overview/birds/solar-page.md rename to getting-started/birds/solar-page.md index 547ebfa..5cc67dc 100644 --- a/overview/birds/solar-page.md +++ b/getting-started/birds/solar-page.md @@ -1,7 +1,7 @@ --- title: Solar Panel Board parent: What is BIRDS? -grand_parent: Home +grand_parent: Getting Started layout: default lang: en --- diff --git a/overview/before-you-start.md b/getting-started/index.md similarity index 94% rename from overview/before-you-start.md rename to getting-started/index.md index 6609ba9..5dd2f0c 100644 --- a/overview/before-you-start.md +++ b/getting-started/index.md @@ -1,18 +1,20 @@ --- -title: Before you start +title: Getting Started nav_order: 3 -parent: Home +has_children: true layout: default +permalink: "/get-started" lang: en --- -# Before You Start + +# Getting Started To ensure a smooth journey in building your CubeSat, there are a few things you'll want to understand beforehand. This section outlines key knowledge areas you'll need, from using the platform and GitHub to understanding systems engineering principles. --- ## Platform Basics: GitHub and Git -To work with Build-A-Sat, you'll need a GitHub account. This is where you'll manage your codebase and contribute to open-source satellite projects. Here’s a quick guide to get you started: +To work with BIRDS, you'll need a GitHub account. This is where you'll manage your codebase and contribute to open-source satellite projects. Here’s a quick guide to get you started: ### 1. **GitHub Account** - Create a [GitHub account](https://github.com/) to access repositories, contribute to projects, and manage your code. @@ -136,3 +138,7 @@ With this foundational knowledge, you’ll be better equipped to dive into the s [Preliminary Design Review (PDR)]: {{site.url}}/project-managers/milestones/pm-pdr.html [Critical Design Review (CDR)]: {{site.url}}/project-managers/milestones/pm-cdr.html [Flight Readiness Review (FRR)]: {{site.url}}/project-managers/milestones/pm-frr.html + + +[Previous]({{site.url}}/get-started){: .btn .btn-purple } +[Next]({{site.url}}/get-started/reference.html){: .btn} diff --git a/gsoc/index.md b/gsoc/index.md index d7b113d..8299b89 100644 --- a/gsoc/index.md +++ b/gsoc/index.md @@ -1,6 +1,6 @@ --- title: GSoC -nav_order: 1 +nav_order: 9 has_children: true has_toc: false layout: default diff --git a/overview/index.en.md b/index.en.md similarity index 82% rename from overview/index.en.md rename to index.en.md index 70957ff..4df48b5 100644 --- a/overview/index.en.md +++ b/index.en.md @@ -2,7 +2,6 @@ title: Home nav_order: 2 layout: home -has_children: true has_toc: false permalink: "/" lang: en @@ -12,28 +11,28 @@ lang: en {: .lh-0 .text-purple-200} # Everything you need to build a satellite -This document covers how to build a satellite from scratch. Readers are expected to have a bachelors degree in space engineering or at least prerequisite knowledge on the basics of a satellite and how it works. +{{site.description}} -If you're new here, here's a list of what to expect in the next few pages: -- [x] Introduction to the Birds bus and other core components +Here's what you can expect: +- [x] Introduction to the BIRDS bus and other core components - [x] How to get started - [x] Deep dives on technical topics
-
+
Getting Started
New to BIRDS? Check out the getting started guides. They contain an introduction to the BIRDS bus’ main concepts and links to additional tutorials. - + go to getting started guides
-
+
Hardware Guide @@ -47,7 +46,7 @@ If you're new here, here's a list of what to expect in the next few pages:
-
+
Software Guide @@ -58,7 +57,7 @@ If you're new here, here's a list of what to expect in the next few pages:
-
+
Contributor’s Guide @@ -70,7 +69,7 @@ If you're new here, here's a list of what to expect in the next few pages:
-
+
Project Details diff --git a/overview/index.jp.md b/index.jp.md similarity index 100% rename from overview/index.jp.md rename to index.jp.md