-
-
Notifications
You must be signed in to change notification settings - Fork 31
Docs Review Sign-up #69
Comments
sounds good Chris @chrisdickinson, I'm down for proof reading. |
Is the #github-announce channel integration working in any way/shape/form ATM or are these docs to be reviewed being listed manually until we get integration hooked up? |
Right now the listing will be manual — I believe @distracteddev is working on an integration for the channel. |
It would be better if only the issues or PRs with doc label are notified in the Slack. |
@thefourtheye Tagged issues and PRs will likely also be included in the github-announce channel. Only announcing labeled items wouldn't be sufficient, however: core PRs may be opened and landed without the |
You mean CTC doesn't expect an LGTM from Docs WG to land a doc change? |
@thefourtheye In the context of a PR that is primarily updating code, that is correct. If a PR only contains documentation, or is primarily documentation-focused, the Docs WG is expected to LGTM. We may be cc'd on an code-related PR to take a look at the docs, but we're not to hold up merges on those PRs. This is a compromise, but a workable one: this issue sets up part of the process for reviewing merged docs. |
@chrisdickinson Hmmm okay. What I am worried about is, there may be additional work if something, that doesn't align with Doc WG way of doing things lands then we may have to amend it with another PR. Perhaps we can improve the tools so that the doc changes are linted when |
@thefourtheye Yep — looping doc linting into |
@chrisdickinson Awesome :-) Let me see if I can contribute to that. |
This is my jam. |
Closing as this repository is dormant and likely to be archived soon. If this is still an issue, feel free to open it as an issue on the main node repository. |
As part of our charter, this WG is required to review documentation coming through PRs in nodejs/node. However, we're to avoid blocking PRs from landing solely based on documentation concerns.
As a result, I propose we start a review of docs that have landed on the
master
branch of Node over the course of the past week. Our goal will be to clarify, correct, and edit recently landed API docs. This should prevent the Docs WG from blocking Core contributors from landing work, while ensuring a high quality of documentation for releases. Docs to be reviewed will be reported in the Docs WG Slack.If your interests lie in spelling, grammar, or editing, this is a task that could benefit from your skills. Please comment on this issue if you're interested in helping out with this.
The text was updated successfully, but these errors were encountered: