Skip to content
This repository has been archived by the owner on Jul 11, 2024. It is now read-only.

review levels & changelog

Jump to bottom
Brian Elton edited this page Apr 17, 2024 · 8 revisions

2024 update process & notes

There are multiple editors making changes to the Tutorials section, so all changes must be reviewed before being merged to master-2.0.

When a branch is ready to be merged:

  • Create a PR to merge that branch into master-2.0
    • Ensure the main page footer Date and the changelog have been updated appropriately (see related sections below)
  • Add a label for the review level needed (labels already exist and are based on 'Reviews' section below)
    • Review level: None
    • Review level: List only
    • Review level: Some review
    • Review level: Working Group Approval
  • If appropriate, add a "Ready to merge" label
  • Coordinate with Shawn to review the PRs

Note: Netlify previews are running twice. example pr One fails set and one works fine. Can ignore that for now. Will clean it up when we get to it.

For every publication update:

  • change the main page "Date: Updated 0 Month 2023." to the date of publication.
  • update the changelog if substantive edits. see 'Goals of this changelog' below.

Reviews

Depending on the type of change:

  1. None -- No review needed, for example: typo fix. Do not list in changelog.
  2. List only -- No review before publication, per EO's process for minor changes. List in changelog (and point EOWG and others to changelog for review).
  3. Some review -- At least two people with expertise in the topic indicate their approval in GitHub. List in changelog (and point EOWG and others to changelog for review).
  4. Working Group Approval -- EOWG, AG WG, and/or ARIA WG based on the content. The Group's Chairs will coordinate review, e.g., through survey or other. List in changelog.

Changelog

Goals of this changelog:

  1. Help reviewers know which are the more significant changes to focus on, and help them not get bogged down on less important ones.
  2. Help tutorial users know if advice they previously followed has changed.

Example: changelog for media resource shows examples of links to GitHub PRs showing diff.

Dates in footer

All pages should have

<p><strong>Date:</strong> Updated @@ Month 2022. First published September 2014. CHANGELOG.</p>

When a page is reviewed and determined to be current good practice, add "Up-to-date as of Month 2023" or "Reviewed on Month 2023" [To Do: decide which :-]

footer issue: https://github.com/w3c/wai-tutorials/issues/697

Clone this wiki locally