|
4 | 4 | This documentation is developed using the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) framework, and the source code for the docs is publicly available on [GitHub](https://github.com/eth-cscs/cscs-docs). |
5 | 5 | This means that everybody, CSCS staff and the CSCS user community can contribute to the documentation. |
6 | 6 |
|
| 7 | +## Before starting |
| 8 | + |
| 9 | +The CSCS documentation takes contributions from all CSCS staff, with a _core team_ of maintainers responsible for ensuring that the overall documentation is well organised, that pages are well written and up to date, and that contributions are reviewd and merged as quickly as possible. |
| 10 | + |
| 11 | +??? question "Who are the core team?" |
| 12 | + The docs core team are: |
| 13 | + |
| 14 | + * Ben Cumming (@bcumming); |
| 15 | + * Mikael Simberg (@msimberg); |
| 16 | + * and Rocco Meli (@RMeli). |
| 17 | + |
| 18 | + We are volunteers for this role, who care about the quality of CSCS documentation! |
| 19 | + |
| 20 | +!!! tip "Before contributing" |
| 21 | + Please read the [guidelines][] and [style guide][] before making any contribution. |
| 22 | + Consistency and common practices make it easier for users to read and navigate the documentation, and these guides are directed towards this. |
| 23 | + We try to strike a balance between following the guidelines and letting authors write in a style that is comfortable for them. |
| 24 | + |
| 25 | + To speed up the merge process and avoid lengthy style discussions, we reserve the right to make changes to pull requests to bring it into line with the guidelines. |
| 26 | + The core team will also update pages when they are out of date or when the style guidelines change. |
| 27 | +!!! tip "Before making large contributions" |
| 28 | + If you plan to make large changes, like adding documentation for a new tool/service or refactoring existing documentation, __reach out to the core team__ before starting. |
| 29 | + |
| 30 | + This will mean that the changes are consistent with other parts of the documentation, streamline the review process, and to avoid misunderstandings. |
| 31 | + |
| 32 | +### Code owners |
| 33 | + |
| 34 | +Many sections have individual staff that follow them. |
| 35 | +This is codified in the [CODEOWNERS](https://github.com/eth-cscs/cscs-docs/blob/main/.github/CODEOWNERS) file in the repository. |
| 36 | +The code owners are notified when there is a change to their pages, and can review the changes. |
| 37 | + |
| 38 | +If you want to follow changes to a page or section, add your name to the CODEOWNERS. |
| 39 | + |
| 40 | +!!! note |
| 41 | + Review from code owners is not required to merge, however the core team will try to get a timely review from code owners whenever possible. |
| 42 | + |
7 | 43 | ## Getting started |
8 | 44 |
|
9 | 45 | We use the GitHub fork and pull request model for development: |
@@ -173,6 +209,17 @@ Screenshots can help readers follow steps on guides. Think if you need to show t |
173 | 209 |
|
174 | 210 | Often, screenshots can quickly become obsolete, so you may want to complement (or maybe even replace) some with text descriptions. |
175 | 211 |
|
| 212 | +!!! tip |
| 213 | + Screen shots take up space in the git repository. |
| 214 | + |
| 215 | + It might be "only a few hundred kilobytes" for a picture, but over the lifetime of the git repository this adds up to slow down source code cloning and CI/CD pipelines. |
| 216 | + |
| 217 | +!!! tip |
| 218 | + Avoid using screen shots that do not directly contribute to the documentation. |
| 219 | + |
| 220 | + For example, showing a screen shot with markers that are used to explain non-trivial steps that a user should follow is good documentation. |
| 221 | + On the other hand, a screenshot that says "this is a screenshot of the tool" adds no value, and draws the readers attention away from documentation. |
| 222 | + |
176 | 223 | #### Diagrams |
177 | 224 |
|
178 | 225 | Diagrams can help readers understand more abstract concepts like processes or architectures. We suggest you use [mermaid](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams). Such format makes diagrams easy to maintain and removes the need to commit image files in the repository. |
|
0 commit comments