docs: Fix some doc links#15119
Merged
MoritzThomasHuebner merged 2 commits intomagma:masterfrom Mar 3, 2023
Merged
Conversation
Signed-off-by: Moritz Huebner <[email protected]>
Signed-off-by: Moritz Huebner <[email protected]>
Contributor
|
Thanks for opening a PR! 💯
Howto
More infoPlease take a moment to read through the Magma project's
If this is your first Magma PR, also consider reading
|
Contributor
mpfirrmann
approved these changes
Mar 3, 2023
Contributor
mpfirrmann
left a comment
There was a problem hiding this comment.
Tested with make dev, links look good.
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]>
This file contains hidden or 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
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.
Summary
Closes #14933
I used IntelliJ IDEA to search for all instances of
/next/within thedocsdirectory 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:
-> 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
magma/docs/docusaurus/versioned_docs/version-1.4.X
-> 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
-> Makes sense, the architecture overview is not significantly different between versions anyway.
-> dead link -> Fixed
magma/docs/docusaurus/versioned_docs/version-1.6.X
-> Similar to 1.4.X
-> Makes sense, this is listed as an example for a proposal and the most up to date version should be linked.
-> Makes sense, we would want to link the latest page about security certificates
magma/docs/docusaurus/versioned_docs/version-1.7.X
-> Makes sense, this is listed as an example for a proposal and the most up to date version should be linked.
-> Makes sense, we would want to link the latest page about security certificates
-> Makes sense, the architecture overview is not significantly different between versions anyway.
-> dead link -> Fixed
magma/docs/docusaurus/versioned_docs/version-1.8.0
-> dead link -> Fixed
Test Plan
CI