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
Shawn Lawton Henry edited this page Feb 17, 2023 · 8 revisions

2023 update process & notes

For edits that do not need review (see 'Reviews' section below)

  • Brian merges into master-2.0 as he processes PRs
  • when ready to publish, by Monday at midnight for a Tuesday publication, Brian updates the main page footer Date and the changelog, creates a PR from master-2.0 branch to publication branch with a summary of the changes, assigns it to shawna_slh, adds a link to the PR in WAI site publication schedule

For edits that might need review:

  • don't merge them into master-2.0 yet
  • Brian lists them in EO-Plan under "For discussion" and we'll figure out approach for review

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>

At some point we might add "Up-to-date Month 2023" when we review a page and determine no updates are needed.

@@ footer issue

Clone this wiki locally