From 0c4a48ad971141de4523d2a970ea183c6232a82a Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Sat, 26 Oct 2024 11:08:48 +0900 Subject: [PATCH 1/3] adde pm and obc colection --- Gemfile | 2 +- README.md | 2 +- _config.yml | 8 ++++++-- _obc-members/getstarted.md | 4 ++++ _project-managers/getstarted.md | 4 ++++ 5 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 _obc-members/getstarted.md create mode 100644 _project-managers/getstarted.md diff --git a/Gemfile b/Gemfile index 4b7af1a..a13ec9d 100644 --- a/Gemfile +++ b/Gemfile @@ -1,7 +1,7 @@ source 'https://rubygems.org' gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` -# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 +gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 gem "just-the-docs", "0.9.0" # pinned to the current release # gem "just-the-docs" # always download the latest release diff --git a/README.md b/README.md index 362efd4..a8bd5b3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# just-the-docs-template +# Build-A-Satellite-Docs This is a *bare-minimum* template to create a [Jekyll] site that: diff --git a/_config.yml b/_config.yml index 035377e..f0a3fc6 100644 --- a/_config.yml +++ b/_config.yml @@ -67,7 +67,7 @@ color_scheme: dark # Define Jekyll collections collections: - # Define a collection named "tests", its documents reside in the "_tests" directory + # Define a collection named "project-managers", its documents reside in the "_project-managers" directory project-managers: permalink: "/:collection/:path/" output: true @@ -75,7 +75,7 @@ collections: just_the_docs: # Define which collections are used in just-the-docs collections: - # Reference the "tests" collection + # Reference the "project-managers" collection project-managers: # Give the collection a name name: For Project Managers @@ -88,3 +88,7 @@ just_the_docs: # Exclude the collection from the search # Supports true or false (default) # search_exclude: true + obc-members: + name: For OBC Team Members + nav_fold: true + diff --git a/_obc-members/getstarted.md b/_obc-members/getstarted.md new file mode 100644 index 0000000..246e1a5 --- /dev/null +++ b/_obc-members/getstarted.md @@ -0,0 +1,4 @@ +--- +title: Getting Started for OBC Team Members +layout: default +--- \ No newline at end of file diff --git a/_project-managers/getstarted.md b/_project-managers/getstarted.md new file mode 100644 index 0000000..a87a882 --- /dev/null +++ b/_project-managers/getstarted.md @@ -0,0 +1,4 @@ +--- +title: Getting Started for Project Managers +layout: default +--- \ No newline at end of file From 507f1d89248160e3fc4bcd75438517dd35fcd339 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Sat, 26 Oct 2024 11:19:37 +0900 Subject: [PATCH 2/3] changed to light theme and added getting started pages for pm and obc collections --- Gemfile.lock | 1 + _config.yml | 5 ++--- _obc-members/get-started.md | 11 +++++++++++ _obc-members/getstarted.md | 4 ---- _obc-members/software-design.md | 8 ++++++++ _project-managers/get-started.md | 11 +++++++++++ _project-managers/getstarted.md | 4 ---- getstarted.md | 11 +++++++++++ index.md | 2 +- 9 files changed, 45 insertions(+), 12 deletions(-) create mode 100644 _obc-members/get-started.md delete mode 100644 _obc-members/getstarted.md create mode 100644 _obc-members/software-design.md create mode 100644 _project-managers/get-started.md delete mode 100644 _project-managers/getstarted.md create mode 100644 getstarted.md diff --git a/Gemfile.lock b/Gemfile.lock index 2e0f059..64ec0ea 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -89,6 +89,7 @@ DEPENDENCIES base64 (~> 0.2.0) jekyll (~> 4.3.3) just-the-docs (= 0.9.0) + webrick BUNDLED WITH 2.5.9 diff --git a/_config.yml b/_config.yml index f0a3fc6..d34e568 100644 --- a/_config.yml +++ b/_config.yml @@ -46,8 +46,7 @@ nav_enabled: true # Footer content # appears at the bottom of every page's main content -# Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust -markup / liquid-based content. +# Note: The footer_content option is deprecated and will be removed in a future major release. Please use `_includes/footer_custom.html` for more robust markup / liquid-based content. footer_content: "Copyright © 2015-2024 Laboratory of Lean Satellite Enterprises and In-Orbit Experiment. Distributed by an MIT license." # Footer last edited timestamp @@ -63,7 +62,7 @@ gh_edit_branch: "main" # the branch that your docs is served from gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately # Color scheme supports "light" (default) and "dark" -color_scheme: dark +color_scheme: light # Define Jekyll collections collections: diff --git a/_obc-members/get-started.md b/_obc-members/get-started.md new file mode 100644 index 0000000..999e06d --- /dev/null +++ b/_obc-members/get-started.md @@ -0,0 +1,11 @@ +--- +title: Getting Started for OBC Team Members +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. diff --git a/_obc-members/getstarted.md b/_obc-members/getstarted.md deleted file mode 100644 index 246e1a5..0000000 --- a/_obc-members/getstarted.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Getting Started for OBC Team Members -layout: default ---- \ No newline at end of file diff --git a/_obc-members/software-design.md b/_obc-members/software-design.md new file mode 100644 index 0000000..bdb4fb5 --- /dev/null +++ b/_obc-members/software-design.md @@ -0,0 +1,8 @@ +--- +title: Software Design +layout: default +--- + +## The fisrt thing to do + +Read the handbook \ No newline at end of file diff --git a/_project-managers/get-started.md b/_project-managers/get-started.md new file mode 100644 index 0000000..5286c01 --- /dev/null +++ b/_project-managers/get-started.md @@ -0,0 +1,11 @@ +--- +title: Getting Started for Project Managers +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. diff --git a/_project-managers/getstarted.md b/_project-managers/getstarted.md deleted file mode 100644 index a87a882..0000000 --- a/_project-managers/getstarted.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Getting Started for Project Managers -layout: default ---- \ No newline at end of file diff --git a/getstarted.md b/getstarted.md new file mode 100644 index 0000000..41c40f1 --- /dev/null +++ b/getstarted.md @@ -0,0 +1,11 @@ +--- +title: Getting Started +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. diff --git a/index.md b/index.md index 3c1e73f..3c06959 100644 --- a/index.md +++ b/index.md @@ -1,5 +1,5 @@ --- -title: Home +title: Introduction layout: home --- From a85395f848fec61821f29a1b0171a99ec9601f90 Mon Sep 17 00:00:00 2001 From: Husseinat Etti-Balogun Date: Sat, 26 Oct 2024 12:19:16 +0900 Subject: [PATCH 3/3] added guide pages for all sections --- _adcs-members/adcs-guide.md | 13 +++++++++++++ .../get-started.md => _com-members/com-guide.md | 4 +++- _config.yml | 13 ++++++++++++- _eps-members/eps-guide.md | 13 +++++++++++++ _obc-members/obc-guide.md | 13 +++++++++++++ .../get-started.md => _project-managers/pm-guide.md | 4 +++- 6 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 _adcs-members/adcs-guide.md rename _project-managers/get-started.md => _com-members/com-guide.md (75%) create mode 100644 _eps-members/eps-guide.md create mode 100644 _obc-members/obc-guide.md rename _obc-members/get-started.md => _project-managers/pm-guide.md (78%) diff --git a/_adcs-members/adcs-guide.md b/_adcs-members/adcs-guide.md new file mode 100644 index 0000000..79b5eca --- /dev/null +++ b/_adcs-members/adcs-guide.md @@ -0,0 +1,13 @@ +--- +title: Guide for ADCS Team Members +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. + +This guide is intended for... \ No newline at end of file diff --git a/_project-managers/get-started.md b/_com-members/com-guide.md similarity index 75% rename from _project-managers/get-started.md rename to _com-members/com-guide.md index 5286c01..dfc01e4 100644 --- a/_project-managers/get-started.md +++ b/_com-members/com-guide.md @@ -1,5 +1,5 @@ --- -title: Getting Started for Project Managers +title: Guide for COM Team Members layout: default --- @@ -9,3 +9,5 @@ layout: default ### *Introduction* This introduction is an overview of the project, how it is organised, and how it works. + +This guide is intended for... \ No newline at end of file diff --git a/_config.yml b/_config.yml index d34e568..c2dc6a7 100644 --- a/_config.yml +++ b/_config.yml @@ -90,4 +90,15 @@ just_the_docs: obc-members: name: For OBC Team Members nav_fold: true - + eps-members: + name: For EPS Team Members + nav_fold: true + com-members: + name: For COM Team Members + nav_fold: true + adcs-members: + name: For ADCS Team Members + nav_fold: true + structure-members: + name: For Structure Team Members + nav_fold: true \ No newline at end of file diff --git a/_eps-members/eps-guide.md b/_eps-members/eps-guide.md new file mode 100644 index 0000000..9be3742 --- /dev/null +++ b/_eps-members/eps-guide.md @@ -0,0 +1,13 @@ +--- +title: Guide for EPS Team Members +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. + +This guide is intended for... \ No newline at end of file diff --git a/_obc-members/obc-guide.md b/_obc-members/obc-guide.md new file mode 100644 index 0000000..af4c1c4 --- /dev/null +++ b/_obc-members/obc-guide.md @@ -0,0 +1,13 @@ +--- +title: Guide for OBC Team Members +layout: default +--- + +## *We make space sector capacity building accessible to everyone* + + +### *Introduction* + +This introduction is an overview of the project, how it is organised, and how it works. + +This guide is intended for... \ No newline at end of file diff --git a/_obc-members/get-started.md b/_project-managers/pm-guide.md similarity index 78% rename from _obc-members/get-started.md rename to _project-managers/pm-guide.md index 999e06d..e758d07 100644 --- a/_obc-members/get-started.md +++ b/_project-managers/pm-guide.md @@ -1,5 +1,5 @@ --- -title: Getting Started for OBC Team Members +title: Guide for Project Managers layout: default --- @@ -9,3 +9,5 @@ layout: default ### *Introduction* This introduction is an overview of the project, how it is organised, and how it works. + +This guide is for... \ No newline at end of file