PoC to parse existing standards to json file with requirements. #388
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
…andards # Conflicts: # package-lock.json # package.json
…andards # Conflicts: # package-lock.json # package.json
docs/standards-requirements.md
Outdated
Comment on lines
16
to
26
| {% for standard in collections.getAllStandardsOrderedByID %} | ||
| <h2 class="app-document-header__title govuk-heading-l"> | ||
| <span class="govuk-caption-l">{{standard.data.id}}</span> | ||
| <a href="{{ standard.url }}" class="govuk-link">{{ standard.data.title }}</a> | ||
| </h2> | ||
| <p class="govuk-hint">Last updated: {{ standard.data.date | postDate }}</p> | ||
|
|
||
| {% for requirement in standard.templateContent | extractRequirements %} | ||
| * [{{requirement.title}}]({{ standard.url }}{{requirement.id}}) | ||
| {% endfor %} | ||
| {% endfor %} |
There was a problem hiding this comment.
Can this be formatted in a better way, to make it easier to be followed
There was a problem hiding this comment.
A lot of that awkwardness is because once the template has been processed it's then parsed as markdown, which cares about the whitespace. It's not getting much benefit from the markdown parsing so refactored to nunjucks/html to make it more readable
…essible when syntax highlighting is used.
… instead of govuk-red that has 1:4.51 ratio
…andards # Conflicts: # package.json
…pshot-of-standards # Conflicts: # package-lock.json # package.json
edhamiltonHO
approved these changes
Apr 18, 2024
aaronrussellHO
approved these changes
Apr 26, 2024
…pshot-of-standards # Conflicts: # package-lock.json # package.json
edhamiltonHO
deleted the
387-feature-ability-to-export-snapshot-of-standards
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a summary page of standards and their requirements that teams can use as a quick reference / to build a doc that assert's their compliance.
This can also be downloaded as a .json file (which has an associated schema.json spec) and a .csv file
that teams can use to assert their compliance in a machine readable way. This is a proof of concept of this page to enable feedback from teams trying to adopt the standard.
Code change
I can confirm:
Accessibility considerations