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

Reference to config.md has a broken link #2366

Closed
rafaeldasilva opened this issue Feb 19, 2021 · 3 comments · Fixed by #2631
Closed

Reference to config.md has a broken link #2366

rafaeldasilva opened this issue Feb 19, 2021 · 3 comments · Fixed by #2631
Labels
bug Something is not working.

Comments

@rafaeldasilva
Copy link

Describe the bug

The link to file "https://github.com/ory/hydra/blob/undefined/docs/docs/reference/config.md" which is indicated on pages such as
https://www.ory.sh/hydra/docs/cli/hydra-serve is broken

I see the file was renamed to https://github.com/ory/hydra/blob/master/docs/docs/reference/configuration.md

Reproducing the bug

Steps to reproduce the behavior:

Click on "https://github.com/ory/hydra/blob/undefined/docs/docs/reference/config.md"

Expected behavior
Open the file https://github.com/ory/hydra/blob/undefined/docs/docs/reference/config.md

@zepatrik
Copy link
Member

Weird that there is undefined in the link. All of the occurrences are in the CLI docs, so the problem is somehow related to how we generate them.

@zepatrik zepatrik added bug Something is not working. docs labels Feb 20, 2021
@vinckr
Copy link
Member

vinckr commented Apr 7, 2021

So for example in serve.go it says:

https://github.com/ory/hydra/blob/` + config.Commit + `/docs/docs/reference/config.md <<

So changing config.md to configuration.md
and making sure that config.Commit is not undefined but the correct commit should fix it.
Not sure where or how the config.Commit is broken, investigating further.

@vinckr
Copy link
Member

vinckr commented Apr 7, 2021

Looking through the history it seem it never really worked, was always undefined as far as i can see.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is not working.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants