Coder Social home page Coder Social logo

Docs Review Sign-up about docs HOT 12 CLOSED

chrisdickinson avatar chrisdickinson commented on July 21, 2024
Docs Review Sign-up

from docs.

Comments (12)

Knighton910 avatar Knighton910 commented on July 21, 2024

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

from docs.

techjeffharris avatar techjeffharris commented on July 21, 2024

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?

from docs.

chrisdickinson avatar chrisdickinson commented on July 21, 2024

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

from docs.

thefourtheye avatar thefourtheye commented on July 21, 2024

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

from docs.

chrisdickinson avatar chrisdickinson commented on July 21, 2024

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

from docs.

thefourtheye avatar thefourtheye commented on July 21, 2024

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

from docs.

chrisdickinson avatar chrisdickinson commented on July 21, 2024

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

from docs.

thefourtheye avatar thefourtheye commented on July 21, 2024

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

from docs.

chrisdickinson avatar chrisdickinson commented on July 21, 2024

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

from docs.

thefourtheye avatar thefourtheye commented on July 21, 2024

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

from docs.

jinglish avatar jinglish commented on July 21, 2024

spelling, grammar, or editing

This is my jam.

from docs.

Trott avatar Trott commented on July 21, 2024

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.

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.