How-to Guide for creating a How-to Guide

About

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!

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

Contributors

Acknowledgements

This work is supported by the Australian BioCommons which is enabled by NCRIS via Bioplatforms Australia funding.

This guide makes use of the ELIXIR toolkit theme

Ideas have also been drawn from other websites using this theme including:

• Infectious Diseases Toolkit
• RDMKit
• WorkflowHub

References

Bert Droesbeke, rafael buono, Finn Bacall, Marek Suchánek, Marion, & Nami Sunami. (2023). ELIXIR-Belgium/elixir-toolkit-theme: 1.25.0 - New contributor placeholders and copy to clipboard (1.25.0). Zenodo. https://doi.org/10.5281/zenodo.7764358

Druskat, Stephan, Spaaks, Jurriaan H., Chue Hong, Neil, Haines, Robert, Baker, James, Bliven, Spencer, Willighagen, Egon, Pérez-Suárez, David, & Konovalov, Alexander. (2021). Citation File Format (1.2.0). Zenodo. https://doi.org/10.5281/zenodo.5171937

Gustafsson, J., Davis, B., de la Pierre, M., Stott, A., Beecroft, S., Downton, M., Edwards, R., Chew, T., Samaha, G., & Al Bkhetan, Z. (2023). Australian BioCommons Documentation Guidelines (Version 1.5.0) [Computer software]