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: Fix ids of two proposals so they appear in sidebars #14979

Merged
merged 2 commits into from
Feb 9, 2023

Conversation

voisey
Copy link
Contributor

@voisey voisey commented Feb 8, 2023

Summary

There are two proposals that have not been displayed in the docs for several releases due to a mismatch in the id in sidebars.json and that in the proposal doc itself. For the "Service Restriction Feature" proposal, I fix this by correcting the ids in the sidebar files, while for the "NMS Regression Testing" proposal, I correct the ids in the proposal docs according to the convention described here.

Test Plan

  • I ran cd $MAGMA_ROOT/docs && make dev successfully locally
  • I checked that for each of the modified versions, the two proposal pages now appear in the sidebar as expected

Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
…n the sidebars

Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
@voisey voisey requested review from a team as code owners February 8, 2023 16:02
@voisey voisey requested a review from ssanadhya February 8, 2023 16:02
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines. label Feb 8, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2023

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@github-actions github-actions bot added the component: docs Documentation-related issue label Feb 8, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2023

DP Lint & Test

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0

Results for commit e6cd796.

@voisey voisey self-assigned this Feb 8, 2023
Copy link
Member

@maxhbr maxhbr left a comment

Choose a reason for hiding this comment

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

LGTM

@voisey voisey merged commit daebbfd into magma:master Feb 9, 2023
lucasgonze pushed a commit to lucasgonze/magma that referenced this pull request Feb 29, 2024
* docs: Fix ids in sidebars for Service Restriction Feature proposal

Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>

* docs: Fix ids of NMS Regression Testing proposal so that it appears in the sidebars

Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>

---------

Signed-off-by: Cameron Voisey <cameron.voisey@tngtech.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: docs Documentation-related issue size/S Denotes a PR that changes 10-29 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants