Skip to content

Commit 9a4106e

Browse files
committed
Clarify Review process
It's confusing to say documentation is owned by everyone and then ask to discuss changes with owners.
1 parent 476421a commit 9a4106e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/contributing/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,11 @@ Then navigate to GitHub, and create a pull request.
5757

5858
## Review process
5959

60-
Documentation is owned by everybody - so don't be afraid to jump in and make changes or fixes where you see that there is something missing or outdated.
60+
Documentation is maintained by everybody - so don't be afraid to jump in and make changes or fixes where you see the need or the potential.
6161

62-
If you plan to make large changes or contributions, please discuss them with the documentation owners beforehand, to make sure that the documentation will fit into the larger documentation structure.
62+
If you plan to make significantly large 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.
6363

64-
If the documentation that you write or update might affect multiple stakeholders, ping them for a review.
65-
If you don't get a timely reply, ask the documentation owners for a review or for permission to merge.
64+
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).
6665

6766
!!! note
6867
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.

0 commit comments

Comments
 (0)