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

Links to README.md files in the docs don't resolve to the docs website #5776

Open
porterchris opened this issue Feb 21, 2024 · 0 comments
Open

Comments

@porterchris
Copy link

Bug

Current Behavior

On the docs website, links to "root" markdown pages such as [Guides section](../guides/README.md) do not resolve to the docs website as root paths, rather they resolve to the github.com/garden-io/garden repository such as https://github.com/garden-io/garden/blob/latest-release/docs/guides/README.md.

Expected behavior

These links should stay relative to the docs website and should route to the intended destination without requiring a 301/302 from the root to a more specific page.

Reproducible example

There are 2 such links in the last paragraph of the https://docs.garden.io/using-garden/using-the-cli page:

Take a look at our [Guides section](../guides/README.md) for in-depth guides on specific use cases and setups, or keep exploring other sections under [Using Garden](./README.md) to learn more about Garden concepts and configuration.

Guides section

actual: https://github.com/garden-io/garden/blob/latest-release/docs/guides/README.md
desired: https://docs.garden.io/guides
note: the desired link redirects to https://docs.garden.io/guides/migrating-to-bonsai

Using Garden

actual: https://github.com/garden-io/garden/blob/latest-release/docs/using-garden/README.md
desired: https://docs.garden.io/using-garden/
note: the desired link redirects to https://docs.garden.io/using-garden/configuration-overview

Workaround

The desired links an be inferred and browsed to manually as well as the docs being somewhat accessible/readable through the github markdown rendering feature.

Suggested solution(s)

  1. Update all README.md links to the intended destinations such as the notes above
  2. Update the docs rendering logic to render README.md links as root links
@10ko 10ko added the docs label Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants