Docs Review Sign-up about docs

[Knighton910]

sounds good Chris @chrisdickinson, I'm down for proof reading.

[techjeffharris]

Docs to be reviewed will be reported in the Docs WG Slack.

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?

[chrisdickinson]

Right now the listing will be manual — I believe @distracteddev is working on an integration for the channel.

[thefourtheye]

It would be better if only the issues or PRs with doc label are notified in the Slack.

[chrisdickinson]

@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 doc label being added, or being blocked on Docs WG review (this is by design — one of the concerns the CTC expressed was that Docs WG work shouldn't block core work.)

[thefourtheye]

You mean CTC doesn't expect an LGTM from Docs WG to land a doc change?

[chrisdickinson]

@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.

[thefourtheye]

@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 make lint is done.

[chrisdickinson]

@thefourtheye Yep — looping doc linting into make test is part of the number 1️⃣ task on the proposed ROADMAP!

[thefourtheye]

@chrisdickinson Awesome :-) Let me see if I can contribute to that.

[jinglish]

spelling, grammar, or editing

This is my jam.

[Trott]

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.