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

Correct the docs navigation links when running component status migrator #1276

Merged
merged 7 commits into from
Aug 5, 2022

Conversation

mxriverlynn
Copy link
Contributor

@mxriverlynn mxriverlynn commented Aug 4, 2022

part of #676

problem

when running the component_status_migrator thor task, the docs site navigation file (docs/src/@primer/gatsby-theme-doctocat/nav.yml) is not being updated to reflect component status and name changes.

for example, running bundle exec thor component_status_migrator ButtonGroup --status beta should change the nav.yml entry for ButtonGroup to have a url of /components/beta/buttongroup. this change is not occurring currently.

solution

this PR updates the component_status_migrator.thor file to ensure the nav.yml navigation is updated correctly.

output

after running bundle exec thor component_status_migrator ButtonGroup --status beta the docs/src/@primer/gatsby-theme-doctocat/nav.yml file now has the following entry for ButtonGroup:

  - title: ButtonGroup
    url: "/components/beta/buttongroup"

screenshot

docs site, after running status migrator:
image

@changeset-bot
Copy link

changeset-bot bot commented Aug 4, 2022

🦋 Changeset detected

Latest commit: 467c38f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@mxriverlynn mxriverlynn mentioned this pull request Aug 4, 2022
54 tasks
@mxriverlynn mxriverlynn temporarily deployed to github-pages August 4, 2022 15:38 Inactive
@mxriverlynn mxriverlynn marked this pull request as ready for review August 4, 2022 15:44
@mxriverlynn mxriverlynn requested review from a team, jonrohan and camertron August 4, 2022 15:44
@mxriverlynn mxriverlynn changed the title [WIP] Correct the docs navigation links when running component status migrator Correct the docs navigation links when running component status migrator Aug 4, 2022
@mxriverlynn mxriverlynn temporarily deployed to github-pages August 4, 2022 18:40 Inactive
@mxriverlynn mxriverlynn temporarily deployed to github-pages August 5, 2022 14:43 Inactive
@mxriverlynn mxriverlynn enabled auto-merge (squash) August 5, 2022 14:45
@mxriverlynn mxriverlynn merged commit 759ea56 into main Aug 5, 2022
@mxriverlynn mxriverlynn deleted the component-migrator-docs-navigation branch August 5, 2022 14:48
@primer-css primer-css mentioned this pull request Aug 5, 2022
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