Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog in guidelines/index.html #4123

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Update changelog in guidelines/index.html #4123

wants to merge 10 commits into from

Conversation

mbgower
Copy link
Contributor

@mbgower mbgower commented Oct 29, 2024

Updated changelog to only record changes made that were preserved through WCAG 2.2's Oct 2023 publication.
Added normative errata to the change log incorporated into the republication
NOTE @iadawn, I took a guess on the actual republication date of Nov 15, which will need to be updated to match the real date.


Preview | Diff

Updated changelog to only record changes made that were preserved through WCAG 2.2's Oct 2023 publication.
Copy link

netlify bot commented Oct 29, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit bc23f43
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/67250e6c6078650008be95da
😎 Deploy Preview https://deploy-preview-4123--wcag2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Added a list of the errata changes to the change log. If these are considered too granular for the change log, they could be moved to the errata page instead.
removed the word "substantive" since some of the things listed are editorial
@mbgower mbgower marked this pull request as ready for review October 29, 2024 15:26
small editorial fixes
@mbgower mbgower requested a review from alastc October 29, 2024 17:06
guidelines/index.html Outdated Show resolved Hide resolved
quotation marks align with other styling
@mbgower
Copy link
Contributor Author

mbgower commented Oct 30, 2024

@kfranqueiro the anchor links to the definitions are not showing up in the preview (circa line 300). I'm assuming they will when published?

@mbgower
Copy link
Contributor Author

mbgower commented Oct 30, 2024

@alastc I've added this to the Errata for CFC column, just to make sure it is not overlooked. This is deviating from our process and is not even necessary, since this update to an appendix of the spec does not need to be part of the CFC process, but I thought it made sense to include in this process.. It has not been reviewed by anyone at this point.

@kfranqueiro
Copy link
Contributor

@kfranqueiro the anchor links to the definitions are not showing up in the preview (circa line 300). I'm assuming they will when published?

I'm not sure what you're referring to near line 300 which is just data-includes in the source, but if you mean #dfn-* links they seem to work fine? I'm also not sure what is responsible for generating the preview/diff links in this PR's description but they don't seem to work. Try using this: https://raw.githack.com/w3c/wcag/changelog/guidelines/index.html

Meanwhile, separate question: I see this is removing content from the change log section; is that all stuff that specifically happened between initial drafts of 2.2 and its final publication?

@kfranqueiro kfranqueiro changed the title Update index.html Update changelog in guidelines/index.html Oct 30, 2024
@mbgower
Copy link
Contributor Author

mbgower commented Nov 1, 2024

@kfranqueiro

if you mean #dfn-* links they seem to work fine

Yes, thanks for the other preview.

Meanwhile, separate question: I see this is removing content from the change log section; is that all stuff that specifically happened between initial drafts of 2.2 and its final publication?

Technically, EVERYTHING that remains in the change log from the original publication is stuff that happened between its initial drafts and final publication, but I have retained a single mention of each new SC that was added, along with any other adopted changes that were made in the spec after 2.1. I have also modified the preamble to try to make this clearer.

guidelines/index.html Outdated Show resolved Hide resolved
slight rewording to clarify what is in the change log
guidelines/index.html Outdated Show resolved Hide resolved
guidelines/index.html Outdated Show resolved Hide resolved
guidelines/index.html Outdated Show resolved Hide resolved
not a definition, so adding relative link
guidelines/index.html Outdated Show resolved Hide resolved
not a definition, so adding relative link
kfranqueiro added a commit that referenced this pull request Nov 15, 2024
This effectively replaces what the pr-preview bot currently does (and
what #2220 sought to do within the repo). The problem with the
pr-preview bot is its previews don't fully work (e.g. as seen in #4123).

## Changes

- Remove `.pr-preview.json` to stop pr-preview bot from running
- Add logic to `eleventy.config.ts` to copy `guidelines` folder assets
and run through spec-generator (the same thing we use for GH Pages
builds; also the same thing used by the pr-preview bot, IIUC) when
running a standard build through netlify
- Conditionally add guidelines list item to top-level `index.html`
(which is only used for local dev and PR builds)
- Tangentially, rename our github-pages push workflow to be more
distinguishable in the Actions tab
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants