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

Dead link on Getting Started site #595

Closed
TheFutonEng opened this issue Jul 1, 2022 · 2 comments · Fixed by #596
Closed

Dead link on Getting Started site #595

TheFutonEng opened this issue Jul 1, 2022 · 2 comments · Fixed by #596
Assignees
Labels
bug 🐞 Something isn't working

Comments

@TheFutonEng
Copy link
Contributor

TheFutonEng commented Jul 1, 2022

At the bottom of this page there is a link to the Walkthroughs:

Screen Shot 2022-07-01 at 1 32 08 PM

However, this leads to a dead link of: https://docs.zarf.dev/docs/getting-started/walkthroughs

I imagine it's supposed to link to: https://docs.zarf.dev/docs/walkthroughs

This is Rob M btw.

@mike-winberry mike-winberry self-assigned this Jul 5, 2022
@mike-winberry mike-winberry added the bug 🐞 Something isn't working label Jul 5, 2022
@mike-winberry mike-winberry transferred this issue from another repository Jul 5, 2022
mike-winberry referenced this issue in defenseunicorns/zarf-docs Jul 5, 2022
@mike-winberry
Copy link
Contributor

Also adjusted the netlify settings per https://docusaurus.io/docs/deployment#deploying-to-netlify to ensure that trailing slashes are no longer added automagically.

@mike-winberry
Copy link
Contributor

mike-winberry commented Jul 5, 2022

Also this is not a dead link issue though it does present as one. The issue is due to the routing on docusaurus not handling nested paths correctly unless the link is specific to a file (ie [Walkthroughs](./13-walkthroughs.md)) when a trailing slash is added to the url. @YrrepNoj we may need to update all links in the documentation to ensure this is not happening if a user adds a trailing slash (ie https://docs.zarf.dev/docs/getting-started/), but I updated the netlify settings to stop adding them automatically which will fix the flow from zarf.dev install to the getting started page and also updated the way the links are referenced in the getting started page to provide a more stable solution that should be implemented going forward. defenseunicorns/zarf-docs#31

@mike-winberry mike-winberry transferred this issue from defenseunicorns/zarf-docs Jul 7, 2022
@RothAndrew RothAndrew moved this from Doing Now to New Requests in Zarf Project Board Jul 7, 2022
mike-winberry added a commit that referenced this issue Jul 7, 2022
…inks should now be valid regardless of wether or not they have been pre-processed by docusaurus.
@mike-winberry mike-winberry linked a pull request Jul 7, 2022 that will close this issue
2 tasks
Repository owner moved this from New Requests to Done in Zarf Project Board Jul 7, 2022
mike-winberry added a commit that referenced this issue Jul 7, 2022
* 595 Fixed all links within 4-user-guide/1-the-zarf-cli

* #595. Udpated all the local links in 4-user-guide/2-zarf-packages

* #595. Update all local links in 5-operator-manual

* #595. Finished fixing the local links within the documentation. All links should now be valid regardless of wether or not they have been pre-processed by docusaurus.
Noxsios pushed a commit that referenced this issue Mar 8, 2023
* 595 Fixed all links within 4-user-guide/1-the-zarf-cli

* #595. Udpated all the local links in 4-user-guide/2-zarf-packages

* #595. Update all local links in 5-operator-manual

* #595. Finished fixing the local links within the documentation. All links should now be valid regardless of wether or not they have been pre-processed by docusaurus.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐞 Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants