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!
Note: 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:
- Fork the template repository - see this page for more details
- A single or multi-page guide?
- Add a single new page to your guide
- Optional: Adding multiple new pages to your guide
- Acknowledge contributions
- Update your About page content
- Deploy to GitHub pages
- Test, review and improve your guide content
- When ready create a GitHub release and link to Zenodo to create a DOI
Then share the How-to Guide!