You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/index.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,9 @@ Documentation is maintained by everybody - so don't be afraid to jump in and mak
55
55
56
56
If you plan to make significant changes, please discuss them with an [issue](https://github.com/eth-cscs/cscs-docs/issues) beforehand, to ensure the changes will fit into the larger documentation structure.
57
57
58
-
If you think your documentation update could affect specific stakeholders, ping them for a review. The same applies if you are not getting get a timely reply for your pull request. You can get some hints of whom to contact by looking at [CODEOWNERS](https://github.com/eth-cscs/cscs-docs/blob/main/.github/CODEOWNERS).
58
+
If you think your documentation update could affect specific stakeholders, ping them for a review.
59
+
The same applies if you are not getting get a timely reply for your pull request.
60
+
You can get some hints of whom to contact by looking at [CODEOWNERS](https://github.com/eth-cscs/cscs-docs/blob/main/.github/CODEOWNERS).
59
61
60
62
!!! note
61
63
To minimise the overhead of the contributing to the documentation and speed up "time-to-published-docs" we do not have a formal review process.
@@ -93,11 +95,11 @@ Instead, we advocate adding unique references to sections.
93
95
94
96
=== "adding a reference"
95
97
96
-
Add a reference above the item, in this case we want to link to the section with the title `## The Fast Server`:
98
+
Add a reference above the item, in this case we want to link to the section with the title `## The fast server`:
97
99
98
100
```
99
-
[](){#ref-servers-fast}
100
-
## Fast Server
101
+
[](){#ref-fast-server}
102
+
## Fast server
101
103
```
102
104
103
105
Use the `[](){#}` syntax to define the reference/anchor.
@@ -110,7 +112,7 @@ Instead, we advocate adding unique references to sections.
110
112
In any other file in the project, use the `[][]` syntax to refer to the link (note that this link type uses square braces, instead of the usual parenthesis):
111
113
112
114
```
113
-
[the fast server][ref-servers-fast]
115
+
[the fast server][ref-fast-server]
114
116
```
115
117
116
118
The benefits of this approach are that the link won't break if
@@ -239,7 +241,7 @@ At the top of each page there is an "edit" icon :material-pencil:, which will op
239
241
Once your changes are ready, click on the "Commit changes..." button in the top right hand corner of the editor, and add at least a description commit message.
240
242
241
243
!!! tip
242
-
See [the GitLab official guide on editing files](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) for a step-by-step walkthrough.
244
+
See [the GitHub official guide on editing files](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) for a step-by-step walkthrough.
243
245
244
246
!!! note
245
247
Use the default option **Create a new branch for this commit and start a pull request**.
0 commit comments