Skip to content

docs: Fix some doc links#15119

Merged
MoritzThomasHuebner merged 2 commits intomagma:masterfrom
MoritzThomasHuebner:fix_some_doc_links
Mar 3, 2023
Merged

docs: Fix some doc links#15119
MoritzThomasHuebner merged 2 commits intomagma:masterfrom
MoritzThomasHuebner:fix_some_doc_links

Conversation

@MoritzThomasHuebner
Copy link
Copy Markdown
Contributor

@MoritzThomasHuebner MoritzThomasHuebner commented Mar 3, 2023

Summary

Closes #14933

I used IntelliJ IDEA to search for all instances of /next/ within the docs directory and went through the results manually. The /next/ directive made sense everywhere except for instances in which we previously had dead links.

Files:

  • magma/docs/readmes/contributing:

    • contribute_proposals.md -> p010_subscriber_scaling.md
      -> Makes sense, this is listed as an example for a proposal and the most up to date version should be linked.
  • magma/docs/readmes/orc8r

    • dev_aws_stack.md -> dev_security.md -> Makes sense, we would want to link the latest page about security certificates
    • p010_subscriber_scaling.md -> architecture_overview.md -> Makes sense, the architecture overview is not significantly different between versions anyway.
  • magma/docs/docusaurus/versioned_docs/version-1.4.X

    • contribute_onboarding.md
      -> Newer versions of this file just link to github, so maybe we should also always link to the latest version of everything.
      -> introduction.md -> Makes sense, introduction doesn't even exist on v1.4
      -> prerequisites.md -> Makes sense, we would like to link to the latest page
      -> testing_tips.md -> Dead link -> Fixed
      -> quick_start_guide.md -> Makes sense, we would like to link the latest quick start guide
  • magma/docs/docusaurus/versioned_docs/version-1.5.X

    • p010_subscriber_scaling.md -> architecture_overview.md
      -> Makes sense, the architecture overview is not significantly different between versions anyway.
    • p014_proposal_process.md -> contribute_conventions.md
      -> dead link -> Fixed
  • magma/docs/docusaurus/versioned_docs/version-1.6.X

    • contribute_onboarding.md
      -> Similar to 1.4.X
    • contribute_proposals.md -> p010_subscriber_scaling.md
      -> Makes sense, this is listed as an example for a proposal and the most up to date version should be linked.
    • dev_aws_stack.md -> dev_security.md
      -> Makes sense, we would want to link the latest page about security certificates
  • magma/docs/docusaurus/versioned_docs/version-1.7.X

    • contribute_proposals.md -> p010_subscriber_scaling.md
      -> Makes sense, this is listed as an example for a proposal and the most up to date version should be linked.
    • dev_aws_stack.md -> dev_security.md
      -> Makes sense, we would want to link the latest page about security certificates
    • p010_subscriber_scaling.md -> architecture_overview.md
      -> Makes sense, the architecture overview is not significantly different between versions anyway.
    • p014_proposal_process.md -> contribute_conventions.md
      -> dead link -> Fixed
  • magma/docs/docusaurus/versioned_docs/version-1.8.0

    • p014_proposal_process.md -> contribute_conventions.md
      -> dead link -> Fixed

Test Plan

CI

Signed-off-by: Moritz Huebner <[email protected]>
Signed-off-by: Moritz Huebner <[email protected]>
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines. label Mar 3, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 3, 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 Mar 3, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 3, 2023

DP Lint & Test

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

Results for commit 3efb3af.

@MoritzThomasHuebner MoritzThomasHuebner marked this pull request as ready for review March 3, 2023 06:57
@MoritzThomasHuebner MoritzThomasHuebner requested a review from a team as a code owner March 3, 2023 06:57
Copy link
Copy Markdown
Contributor

@mpfirrmann mpfirrmann left a comment

Choose a reason for hiding this comment

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

Tested with make dev, links look good.

@MoritzThomasHuebner MoritzThomasHuebner merged commit 43668db into magma:master Mar 3, 2023
lucasgonze pushed a commit to lucasgonze/magma that referenced this pull request Feb 29, 2024
* docs: Fixed a link

Signed-off-by: Moritz Huebner <[email protected]>

* docs: Fixed some links

Signed-off-by: Moritz Huebner <[email protected]>

---------

Signed-off-by: Moritz Huebner <[email protected]>
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/XS Denotes a PR that changes 0-9 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Evaluate usage of /next/ in Magma docs

2 participants