ACT Rules

Continuous Deployment

Preview

Useful links:

• How to Create and Edit Documents
• Design Components
• 2021 redesign: open issues

Purpose

This repo receives Rules content and assets from the ACT-Rules repository of the ACT-Rules Community Group, after processing done by the ACT-Tools suite.

• Rules content and assets get pushed automatically on merge to the develop branch of the ACT-Rules repository. If you have comments about the rules, open a new issue on the ACT-Rules.github.io.
• Setting a rule as "approved", or "proposed" is handled via GitHub actions on the ACT-Rules repository.
• Implementation data is handled by additional scripts on the ACT-Tools.

Set a rule to "approved"

1. On the ACT-rules CG repo, go to the Set a rule to approved GitHub Action.
2. Open "Run workflow", fill in the Rule ID, and optionally a branch name. When updating a rule that has been approved before, fill in a list of one or more changes from the previously approved rule version.
3. Click "Run Workflow" and wait until it completes
4. Go to w3c/wcag-act-rules Pull Requests and open a pull request from the branch that the GitHub action created. You can append multiple approved rules to the same PR by running the same action more than once with the chosen branch.

Deprecating an approved rule

1. Remove the index.md file
2. Remove the rule from rule-versions.yml
3. Remove test cases from testcases.json (if any)
4. Set the rule to "proposed" in wcag-mapping.json

Adding a new implementation

1. Refer to the ACT-Tools repository for instructions on how to map a new implementation and update existing implementations.
2. In this repo, create a pull request with:

• the implementation report generated by the scripts under _data/wcag-act-rules/implementations/,
• updates to the act-implementations.yml file,
• a new page for the implementation details to show up on the WAI website under content/implementations/.

To avoid errors, copy an existing yml block and implementation page and replace the values with the ones for the new mapped implementation.