Update instructions - single page default guide

_data/sidebars/main.yml

@@ -3,13 +3,17 @@ subitems:
     url: /
   - title: 1. Create a new repository
     url: /create_new
-  - title: 2. Update your landing page content
-    url: /update_index
-  - title: 3. Add new pages to your guide
+  - title: 2. A single or multi-page guide?
+    url: /select_type
+  - title: 3. Add a single new page to your guide
+    url: /add_single_page
+  - title: 4. Adding multiple new pages to your guide
     url: /add_new_pages
-  - title: 4. Test & improve your guide content
+  - title: 5. Update your About page content
+    url: /update_about
+  - title: 6. Test & improve your guide content
     url: /improve_content
-  - title: 5. Make your guide citable
+  - title: 7. Make your guide citable
     url: /zenodo
   - title: Different types of How-to Guides
     url: /how_to_guide_types

_data/topnav.yml

@@ -1,10 +1,10 @@
 ## 
 ## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
 subitems:
-- title: About
-  url: /about
 - title: Guide
   url: /
+- title: About
+  url: /about
 - title: Back to How-to Hub
   url: https://australianbiocommons.github.io/how-to-hub/documentation
 

index.md

@@ -5,13 +5,27 @@ description: An abbreviated high level guide for creating a new set of web pages
 toc: false
 ---
 
+This guide describes *How-to* create new How-to Guide websites using a GitHub repository template. 
+
+**What are How-to Guides?** They are step-by-step guides that support the reuse of bioinformatics tools, workflows and data on Australian compute systems and infrastructure.
+
+The template described in these docs aims to:
+- **Reduce the time you spend** creating guides by providing a standard structure to develop and maintain guidance material;
+- **Provide further guide templates** for common use cases of the How-to Guides concept;
+- Allow you to **easily deploy these guides** using GitHub pages and a remote theme provided by ELIXIR; and,
+- Allow linking to Zenodo and **creation of DOIs** for each release. You created the content, others should be able to cite it!
+
+{% include callout.html type="note" content="the instructions below are for a simple guide that can accommodate a few pages only: if you require more complicated structures, please contact @supernord via GitHub" %}
+
 
 These are the steps required to make use of the contents of the How-to Guide template repository:
 
 1. [Fork the template repository](https://github.com/AustralianBioCommons/guide-template) - see [this page](create_new) for more details
-2. [Update your landing page content](update_index)
-3. [Add content pages to your guide](add_new_pages)
-4. [Test, review and improve your guide content](improve_content)
-5. [When ready create a GitHub release and link to Zenodo to create a DOI](zenodo)
+2. [A single or multi-page guide?](select_type)
+3. [Add a single new page to your guide](add_single_page)
+4. Optional: [Adding multiple new pages to your guide](add_new_pages)
+5. [Update your About page content](update_about)
+6. [Test, review and improve your guide content](improve_content)
+7. [When ready create a GitHub release and link to Zenodo to create a DOI](zenodo)
 
 Then share the How-to Guide!

pages/about.md

@@ -6,7 +6,7 @@ toc: false
 
 ## About
 
-This web page describes *How-to* create new How-to Guide websites using a GitHub repository template. 
+This guide describes *How-to* create new How-to Guide websites using a GitHub repository template. 
 
 **What are How-to Guides?** They are step-by-step guides that support the reuse of bioinformatics tools, workflows and data on Australian compute systems and infrastructure.
 
@@ -16,9 +16,6 @@ The template described in these docs aims to:
 - Allow you to **easily deploy these guides** using GitHub pages and a remote theme provided by ELIXIR; and,
 - Allow linking to Zenodo and **creation of DOIs** for each release. You created the content, others should be able to cite it!
 
-{% include callout.html type="note" content="the instructions below are for a simple guide that can accommodate a few pages only: if you require more complicated structures, please contact @supernord via GitHub" %}
-
-
 ## Please cite this guide as follows
 
 > Gustafsson, J., Al Bkhetan, Z., Shadbolt, M., Murigneux, V., Williams, S., Capon, P., Khan, F. Z., & Nelson, T. (2023). How-to Guide for creating a How-to Guide (Version 1.0.0) [Computer software]. https://doi.org/10.5281/zenodo.8210269

pages/add_single_page.md

@@ -0,0 +1,21 @@
+---
+title: Adding a single new guide page to your project
+type: guides
+description: How to create and update a single new guide page for your How-to Guide.
+toc_depth: 2
+---
+
+
+**A single page guide only requires the addition of content to 2 files in the repository template.**
+
+- All of your How-to Guide content (i.e. the information or guidance you would like to share) should be added to [index.md](https://github.com/AustralianBioCommons/guide-template/blob/132851cbc0bb112cafbaa623487e4524af5dee36/index.md), and 
+- All the information that describes the How-to Guide - purpose, citation instructions, contributors, acknowledgements, and references - should be added to [about.md](https://github.com/AustralianBioCommons/guide-template/blob/132851cbc0bb112cafbaa623487e4524af5dee36/pages/about.md).
+
+The template repository contains some example structures that can be used for the content of `index.md`, and include:
+
+- [Standard page that can be used as a starting point for any type of guide]()
+- [Suggested structure for a guide describing how to use a bioinformatics workflow]()
+- [Suggested structure for documentation describing a workflow: based on Australian BioCommons documentation guidelines]()
+
+To use any of these examples, simply copy the markdown content from the relevant example file into the `index.md` file in your repository.
+

pages/select_type.md

@@ -0,0 +1,14 @@
+---
+title: Decide on single or multi-page initial structure
+type: guides
+description: Choosing between a single page and multi-page structure for your How-to Guide.
+toc_depth: 2
+---
+
+The default repository is configured for a single page guide, as well as an `About` page that can be used for additional information such as `citation instructions`, `acknowledgements`, and `references`. Navigation between these pages uses the buttons in the top navigation bar.
+
+However, it is possible, and relatively straightforward, to modify the repository to allow for multiple pages with a navigation bar on the left hand side. You can even add multiple distinct left hand navigation panels that help a user navigate to unique sets of pages, and then use the top navigation bar to toggle between these sets of pages.
+
+If you would like to set up a default How-to Guide with a single page for the main guide, proceed directly to the instructions for [adding a single new page to your guide](add_single_page.md).
+
+If you would like to add multiple pages, or more complicated navigation structures, proceed to the instructions for [adding multiple new pages to your guide](add_new_pages.md).

pages/update_index.md → pages/update_about.md

@@ -1,12 +1,12 @@
 ---
-title: Updating your How-to Guide landing page
+title: Update your About page content
 type: guides
 description: How to update the content for your How-to Guide landing page.
 toc: false
 ---
 
 
-The [`index.md`](https://github.com/AustralianBioCommons/guide-template/blob/ef31713ddb011e3fed11ad36aacd993761f9d771/index.md) page in your new repository will be the landing page for the How-to Guide.
+The [about.md](https://github.com/AustralianBioCommons/guide-template/blob/132851cbc0bb112cafbaa623487e4524af5dee36/pages/about.md) page in your new repository will be the landing page for the How-to Guide.
 
 1. Add general information about the guide you are creating to the `About` section.
 2. Add citation instructions to the `Please cite this guide as follows` section.