Documentation contribution guidelines
1. How to contribute
The documentation is produced by the GLiCID technical team.
GLiCID users may nevertheless want to offer their documentation page.
This page offers an overview of best-practice suggestions for contributing documentation. We strongly recommend reviewing this page before wanting contributing to the GLiCID documentation - thanks!
1.1. Want to help us improve our documentation?
We want GLiCID users to have clear, comprehensive, and easy-to-use documentation.
If you want to alert us to things that are missing or no longer up to date, or if you have ideas on how to improve it, then you can let us know by email by creating a ticket at Glicid Help.
1.2. Create new pages
What type of content can be proposed by users:
-
tutorials illustrating how to optimize GLiCID resources for a use case
-
installation and use of software on GLiCID clusters
You can suggest new pages to us to increase the documentation. To do this, ask:
-
To contact us beforehand via Glicid Help so that we can make contact beforehand.
| Please tell us your GLiCID login. The proposed title and a summary: (100 words maximum) |
-
to use the AsciiDOC format
| Here is an AsciiDoc template link to understand the syntax. |
-
anonymize content and use English
-
take screenshots to illustrate your comments and anonymize them
-
accept that your documentation page may be subject to modification requests by the GLiCID team.
| Before publishing your documentation page, we will check for technical accuracy, formatting, typos/bugs and plagiarism. |
1.3. Advanced contributor
| Advanced contributor are those who have already contributed to the documentation as explained previously with expertise in GitLab and open-source contributions. |
If you meet these qualifications and are interested in contributing, please contact us directly. We will provide you with the necessary prerequisites to get started.
Your knowledge will be highly valuable in improving our documentation. We look forward to working with you!