Skip to content

Commit c2862f1

Browse files
committed
Bonus fixes in contributing guide
1 parent dfd16e2 commit c2862f1

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/contributing/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ Documentation is maintained by everybody - so don't be afraid to jump in and mak
5555

5656
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.
5757

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).
5961

6062
!!! note
6163
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.
9395

9496
=== "adding a reference"
9597

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`:
9799

98100
```
99-
[](){#ref-servers-fast}
100-
## Fast Server
101+
[](){#ref-fast-server}
102+
## Fast server
101103
```
102104

103105
Use the `[](){#}` syntax to define the reference/anchor.
@@ -110,7 +112,7 @@ Instead, we advocate adding unique references to sections.
110112
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):
111113

112114
```
113-
[the fast server][ref-servers-fast]
115+
[the fast server][ref-fast-server]
114116
```
115117

116118
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
239241
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.
240242

241243
!!! 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.
243245

244246
!!! note
245247
Use the default option **Create a new branch for this commit and start a pull request**.

0 commit comments

Comments
 (0)