docs icon indicating copy to clipboard operation
docs copied to clipboard

Update "Self-review checklist"

Open meowius opened this issue 1 year ago • 2 comments

This proposes some small updates to the "Self-review checklist" to support the Hubber-led docs work

  • Add a link to "Best practices for GitHub Docs," which was published after this article was last updated
  • Change into checklist syntax with checkboxes to be more checklist-like

Why:

Closes: https://github.com/github/docs-strategy/issues/2689

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [ ] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • [ ] For content changes, I have completed the self-review checklist.

meowius avatar Jul 01 '24 18:07 meowius

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jul 01 '24 18:07 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
contributing/collaborating-on-github-docs/self-review-checklist.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server

github-actions[bot] avatar Jul 01 '24 18:07 github-actions[bot]

Moving to docs-internal 👍

meowius avatar Jul 03 '24 15:07 meowius