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

docs: update title props description to explain usage #473

Merged
merged 3 commits into from
Feb 6, 2025

Conversation

melaniebmn
Copy link
Collaborator

@melaniebmn melaniebmn commented Feb 4, 2025

Summary | Résumé

Updating the title description for the card-title-tag and notice-title-tag props to make it clearer to users why setting the correct heading level for these properties is important, even though the font size remains the same.

Zenhub ticket

Zenhub ticket for the requested change.

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-473.d35vdwuoev573o.amplifyapp.com

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-473.djtlis5vpn8jd.amplifyapp.com

@melaniebmn melaniebmn marked this pull request as ready for review February 6, 2025 01:31
Copy link
Collaborator

@daine daine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melaniebmn melaniebmn merged commit ced0997 into main Feb 6, 2025
3 checks passed
@melaniebmn melaniebmn deleted the docs/description-for-title-props branch February 6, 2025 16:30
ethanWallace added a commit that referenced this pull request Feb 12, 2025
* Update roadmap pages after Q3 (#427)

* Update accessibility.md

Added draft EN content (for presentation), will probably be refined further once I get comments from Amy. Matilde's comments have been applied.

Not sure about the link to contact us page though at the bottom of the page, it's not on the same level.

* Update accessibility.md

* Update accessibility.md

Adjusted spacing and indentation.

* docs: fix formatting of list

* docs: update feuille-de-route.md (#458)

* Update feuille-de-route.md

* Update feuille-de-route.md

FR translation of disclaimer section at the end.

* Update src/fr/feuille-de-route.md

---------

Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>

* docs: update roadmap.md (#457)

Update roadmap.md

Updated status of roadmap items post Q2 2025.
Edited Templates line item, reduced scope to only basic page template.
Separated Tag component and marked as deprioritized.
Added a disclaimer on changes to be expected to the roadmap.

* Update accessibility.md

Deleted content to make way for updates by Charlotte.

---------

Co-authored-by: Daine Trinidad <daine.trinidad@cds-snc.ca>
Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>

* fix: GC official symbols English link (#476)

* remove: Deprecated radio button pages (#475)

* docs: update title props description to explain usage (#473)

* docs: update title props description to explain usage

* docs: update title props description to explain usage

* docs: add guidance for grid gap prop (#474)

* feat: Add a11y tests and GitHub action (#460)

* Add cypress test to test a11y on all pages

* Update a11y-tests.yml to use cypress test

* Various a11y fixes identified by testing

* Update github action

* Try to solve permission error

* Try to solve permission issue

* Update a11y-tests.yml

* Optimize test + dead links scan

* Fix dead links

* feat: Convert component previews to iframes (#466)

* New baseComponentPreview shortcode

* Switch English pages to use iframe

* Switch French pages to use iframe

* Add logic to retain proper height in iframes

* Uncomment action in a11y test

* PR feedback: code refinement

* Split EN/FR site a11y tests into seperate test files

* Add timeout to visit

* increase timeout time

* Remove uppercase letter from url

* Fix scripts to allow preview build

* Switch terminalLog to command and improve log output

* Remove extra space

* chore(deps): update all non-major github action dependencies (#477)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix: Component preview iframe permissions (#490)

* fix: update x-frame-options to allow component previews (#491)

* chore: synced file(s) with cds-snc/site-reliability-engineering (#478)

* chore: synced local '.github/workflows/s3-backup.yml' with remote 'tools/sre_file_sync/s3-backup.yml'

* chore: synced local '.github/workflows/ossf-scorecard.yml' with remote 'tools/sre_file_sync/ossf-scorecard.yml'

---------

Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com>

* Update en.json - add accessibility page

* Fix: Update fr.json add French accessibility page to data links

* Update src/en/en.json

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

---------

Co-authored-by: Abdul <99345399+adorayi@users.noreply.github.com>
Co-authored-by: Daine Trinidad <daine.trinidad@cds-snc.ca>
Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>
Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com>
Charcharbinkz added a commit that referenced this pull request Feb 12, 2025
* Add accessibility statement content

* Update installation page to include link to a11y statement

* Update installation.md

swapped out markdown link for GCDS link

* Update accessibility page - external attribute links

* Add <p> tags to details component.md

* Content updates to accessibility page.md

After bilingual review with Amy

* Update installation - add external tag to link.md

* Update installation - FR.md

* Update installation-EN.md

Fixed url

* Update installation-EN.md

revert external link changes. markdown for internal link to a11y page.

* Update installation-FR.md

revert external link back to internal a11y page link.

* Add accessibilite content - FR.md

* Update src/en/installation.md

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

* Update src/fr/installation.md

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

* Update src/fr/accessibilite.md

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

* Update src/en/accessibility.md

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

* Update src/en/accessibility.md

Co-authored-by: Amy Morris <75379836+SmartMouthWords@users.noreply.github.com>

* Update src/en/accessibility.md

Co-authored-by: Amy Morris <75379836+SmartMouthWords@users.noreply.github.com>

* Update src/fr/accessibilite.md

Co-authored-by: Amy Morris <75379836+SmartMouthWords@users.noreply.github.com>

* Fix: Update en and fr json - add accessibility page (#492)

* Update roadmap pages after Q3 (#427)

* Update accessibility.md

Added draft EN content (for presentation), will probably be refined further once I get comments from Amy. Matilde's comments have been applied.

Not sure about the link to contact us page though at the bottom of the page, it's not on the same level.

* Update accessibility.md

* Update accessibility.md

Adjusted spacing and indentation.

* docs: fix formatting of list

* docs: update feuille-de-route.md (#458)

* Update feuille-de-route.md

* Update feuille-de-route.md

FR translation of disclaimer section at the end.

* Update src/fr/feuille-de-route.md

---------

Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>

* docs: update roadmap.md (#457)

Update roadmap.md

Updated status of roadmap items post Q2 2025.
Edited Templates line item, reduced scope to only basic page template.
Separated Tag component and marked as deprioritized.
Added a disclaimer on changes to be expected to the roadmap.

* Update accessibility.md

Deleted content to make way for updates by Charlotte.

---------

Co-authored-by: Daine Trinidad <daine.trinidad@cds-snc.ca>
Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>

* fix: GC official symbols English link (#476)

* remove: Deprecated radio button pages (#475)

* docs: update title props description to explain usage (#473)

* docs: update title props description to explain usage

* docs: update title props description to explain usage

* docs: add guidance for grid gap prop (#474)

* feat: Add a11y tests and GitHub action (#460)

* Add cypress test to test a11y on all pages

* Update a11y-tests.yml to use cypress test

* Various a11y fixes identified by testing

* Update github action

* Try to solve permission error

* Try to solve permission issue

* Update a11y-tests.yml

* Optimize test + dead links scan

* Fix dead links

* feat: Convert component previews to iframes (#466)

* New baseComponentPreview shortcode

* Switch English pages to use iframe

* Switch French pages to use iframe

* Add logic to retain proper height in iframes

* Uncomment action in a11y test

* PR feedback: code refinement

* Split EN/FR site a11y tests into seperate test files

* Add timeout to visit

* increase timeout time

* Remove uppercase letter from url

* Fix scripts to allow preview build

* Switch terminalLog to command and improve log output

* Remove extra space

* chore(deps): update all non-major github action dependencies (#477)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* fix: Component preview iframe permissions (#490)

* fix: update x-frame-options to allow component previews (#491)

* chore: synced file(s) with cds-snc/site-reliability-engineering (#478)

* chore: synced local '.github/workflows/s3-backup.yml' with remote 'tools/sre_file_sync/s3-backup.yml'

* chore: synced local '.github/workflows/ossf-scorecard.yml' with remote 'tools/sre_file_sync/ossf-scorecard.yml'

---------

Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com>

* Update en.json - add accessibility page

* Fix: Update fr.json add French accessibility page to data links

* Update src/en/en.json

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>

---------

Co-authored-by: Abdul <99345399+adorayi@users.noreply.github.com>
Co-authored-by: Daine Trinidad <daine.trinidad@cds-snc.ca>
Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>
Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com>

* Update accessibilite - fr.md

---------

Co-authored-by: Ethan Wallace <ethan.wallace.91@gmail.com>
Co-authored-by: Amy Morris <75379836+SmartMouthWords@users.noreply.github.com>
Co-authored-by: Abdul <99345399+adorayi@users.noreply.github.com>
Co-authored-by: Daine Trinidad <daine.trinidad@cds-snc.ca>
Co-authored-by: Melanie Boeckmann <melanie.bockmann@gmail.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants