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 404'ing links #56

Closed
jasonmadigan opened this issue Jan 29, 2024 · 5 comments
Closed

Fix 404'ing links #56

jasonmadigan opened this issue Jan 29, 2024 · 5 comments
Assignees

Comments

@jasonmadigan
Copy link
Member

jasonmadigan commented Jan 29, 2024

  • Fix some broken links
  • Alter build to use -s mkdocs build (strict mode - fails on WARNING)
  • Alter some absolute links to be relative

Example warnings:

WARNING -  Doc file 'authorino/docs/features.md' contains a relative link '../install/crd/authorino.kuadrant.io_authconfigs.yaml', but the target
           'authorino/install/crd/authorino.kuadrant.io_authconfigs.yaml' is not found among documentation files.
WARNING -  Doc file 'authorino/docs/user-guides/deny-with-redirect-to-login.md' contains a relative link 'user-guides/http-basic-authentication.md', but the target
           'authorino/docs/user-guides/user-guides/http-basic-authentication.md' is not found among documentation files.
INFO    -  Doc file 'limitador/README.md' contains an absolute link '/doc/how-it-works.md', it was left as is.
INFO    -  Doc file 'limitador/README.md' contains an unrecognized relative link 'limitador-server/kubernetes/', it was left as is. Did you mean
           'limitador-server/kubernetes/README.md'?
INFO    -  Doc file 'limitador/README.md' contains an unrecognized relative link 'LICENSE', it was left as is.
WARNING -  Doc file 'limitador/limitador-server/README.md' contains a relative link 'examples/limits.yaml', but the target
           'limitador/limitador-server/examples/limits.yaml' is not found among documentation files.
WARNING -  Doc file 'limitador/limitador-server/README.md' contains a relative link 'examples/envoy.yaml', but the target
           'limitador/limitador-server/examples/envoy.yaml' is not found among documentation files.
@jasonmadigan
Copy link
Member Author

jasonmadigan commented Jan 29, 2024

Repos affected (so far):

  • docs.kuadrant.io
  • multicluster-gateway-controller
  • authorino
  • limitador-operator
  • architecture
  • limitador
  • kuadrant-operator

@jasonmadigan
Copy link
Member Author

PRs created

@jasonmadigan
Copy link
Member Author

jasonmadigan commented Feb 6, 2024

#57 - this will remain on hold for the time-being.

Need new releases for various upstream components, and this change isn't really enough to justify new builds of all of the components here. Changes are landed on main for these, so when these changes get released over time, we should eventually be able to land this and turn strict builds on.

Will track the status of these in this issue - one these all get bumps, this can land:

@jasonmadigan
Copy link
Member Author

Resolved a few weeks back, docs builds are with mkdocs -s now

@github-project-automation github-project-automation bot moved this to Done in Kuadrant May 13, 2024
@jasonmadigan jasonmadigan self-assigned this May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant