Skip to content
4 changes: 2 additions & 2 deletions src/en/wizden-staff/maintainer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ An SS14 maintainer maintains the content side of Space Station 14. This includes

### Documaintainer

A documaintainer is an SS14 maintainer who only has maintainer powers for the docs repository. Within the docs repository, they have the same power and authority as an SS14 maintainer.
A documaintainer is an SS14 maintainer with equal authority over the docs repository and some permissions in the content repository. While they handle changes to the docs repository and the SS14 guidebook, they do not handle design documents or non-guidebook changes.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A documaintainer is an SS14 maintainer with equal authority over the docs repository and some permissions in the content repository. While they handle changes to the docs repository and the SS14 guidebook, they do not handle design documents or non-guidebook changes.
A documaintainer is an SS14 maintainer with equal authority over the docs repository and some permissions in the content repository.

Seems a little awkward at with equal authority over.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that you may have a point. I will see to editing the part to sound less awkward.


### Head Mapper

Expand All @@ -24,7 +24,7 @@ An art lead is an SS14 maintainer who has exclusive power over content PRs with

### UI Lead

A UI lead is an SS14 maintainer who has exclusive power over content PRs with UI changes and additions. These maintainers are expected to ensure the game retains usable, aesthetically pleasing UIs which fit the game's art style.
A UI lead is an SS14 maintainer who has exclusive power over content PRs with UI changes and additions. These maintainers are expected to ensure the game retains usable, aesthetically pleasing UIs that fit the game's art style.

### Robust Toolbox Maintainer

Expand Down
24 changes: 21 additions & 3 deletions src/en/wizden-staff/maintainer/doc-review-procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,32 @@
The Docs repo has a different review policy compared to the Content repository.
Since the Docs repo can be pushed to directly by maintainers, is mostly text-based, can be easily reverted/changed, and does not affect forks, most docs pull requests can be handled by a single maintainer.

### Pushing to the Docs Repo
Maintainers have direct push access to the Docs repo and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar.
### Pushing to the Docs and Content Repositories
Maintainers and docutainers have direct push access to the docs repository and are encouraged to use it to update any outdated information, whether it's technical documentation, amending a design document, or just fixing grammar.

Docutainers can also review and merge guidebook PRs on the content repository, but should not abuse this to merge non-guidebook-related pull requests.

### PR Reviews
PRs that update instructional or reference documentation (including, but not limited to, setup guides, style guides, and system documentation) require only a single approval before they can be merged.
Likewise, only a single maintainer needs to express concern to close it.

Note that this does not apply to changes to internal procedure or other modifications that require voting or group deliberation according to relevant policy.
Note that this does not apply to changes to internal procedures or other modifications that require voting or group deliberation under relevant policy.

When leaving comments or requesting changes:
- Use **constructive** language and avoid being overly negative.
- Try not to be _overly_ vulgar or swear in a derogatory way.
- Avoid comments that personally criticize the author.
- It's okay to critique ideas and decisions, but you shouldn't insult their character.
Comment on lines +18 to +21
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Etiquette can probably be put in a more general document for PR reviews so that this doc is focused solely on document review on top of the regular PR review guidelines.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will keep this in mind for later. Thank you.

- For people who may not be familiar with a part in their PR, try to be more thorough in your explanations.
- Explain your review to teach people unfamiliar with the subject.
- When possible, direct people to either the [developer wiki](https://docs.spacestation14.com/index.html), `#docs` discord channel, or an alternate source for information.
- Make time to respond to questions or comments from the PR author on your review comments, so that the author doesn't have to assume and make mistakes.
- You don't need to be constantly online, but if the author has questions, they should be able to get a response in a reasonable amount of time.
- Be formal when closing PRs.
Comment thread
RemFexxel marked this conversation as resolved.
- Explain the reasoning behind doing so while providing constructive criticism about their pull request.
- Discourage others from engaging in rude behavior and try not to upset the PR author. People can often be emotional after their PR is closed.
- For relatively minor changes, opt to simply [complete them yourself](https://cli.github.com/manual/gh_pr_checkout) and push to the PR.
- When requesting changes to a PR, keep them within the scope of the PR.

#### Design Documents
Major PRs that introduce or change a design document should require at least two maintainer approvals. Unlike other doc PRs, design docs can only be approved by those with content maintainer permissions.
Expand Down
Loading