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

Fix "introduction" link, so docs work #3446

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nottrobin
Copy link

@nottrobin nottrobin commented Sep 26, 2022

(Found your project through https://goodfirstissue.dev/, which I was looking at because my team are getting an early start on Hacktoberfest this week. Looks super interesting. Thanks!)

At present, if you click "Introduction" in the README.md it takes you to https://docs.lando.dev/getting-started. If you then read all the way down the page and click the "what-it-do.html" next link at the bottom, it will take you to https://docs.lando.dev/what-it-do.html which is a 404.

Adding a / makes that link take you to https://docs.lando.dev/getting-started/what-it-do.html instead, which works.

This fixes this one instance of this flow from the README.md page. However, a better fix would be to do one of the following:

a) Configure the sever to use redirects to always add the / to the end of directory URLs; or:
b) Use absolute rather than relative links in the documentation navigation so it doesn't matter what the path of the origin page is.

At present, if you click "Introduction" in the README.md it takes you to https://docs.lando.dev/getting-started. If you then read all the way down the page and click the "what-it-do.html" next link at the bottom, it will take you to https://docs.lando.dev/what-it-do.html which is a 404.

Adding a `/` makes that link take you to https://docs.lando.dev/getting-started/what-it-do.html instead, which works.

This fixes this one instance of this flow from the README.md page. However, a better fix would be to do one of the following:

a) Configure the sever to use redirects to always add the `/` to the end of directory URLs; or:
b) Use absolute rather than relative links in the documentation navigation so it doesn't matter what the path of the origin page is.
@stale
Copy link

stale bot commented May 9, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions and please check out this if you are wondering why we auto close issues.

@stale stale bot added the stale Issue has been auto-flagged as stale label May 9, 2023
@stale stale bot removed the stale Issue has been auto-flagged as stale label Sep 4, 2023
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.

None yet

2 participants