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 in Getting Started page are broken #3180

Closed
josemaia opened this issue Jul 22, 2021 · 7 comments
Closed

Links in Getting Started page are broken #3180

josemaia opened this issue Jul 22, 2021 · 7 comments
Assignees
Labels
kind/bug An issue that reports a defect in an existing feature kind/documentation An issue that reports an update related to project documentation

Comments

@josemaia
Copy link

Description:

Internal links in Getting Started page are redirecting wrongly, to a 404 page.

Steps to reproduce the issue:

  1. https://kubeapps.com/docs/getting-started/
  2. click "configure an OAuth2/OIDC provider" in Step 2
  3. hit nginx 404 page

Additional information you deem important (e.g. issue happens only occasionally):

Link appears to be rewriting partially, e.g. https://kubeapps.com/docs/getting-started/using-an-OIDC-provider instead of the correct https://kubeapps.com/docs/using-an-OIDC-provider

@absoludity absoludity added kind/documentation An issue that reports an update related to project documentation size/XS labels Jul 23, 2021
@absoludity
Copy link
Contributor

Thanks @josemaia , yes the docs were recently restructured and we'd missed that we need to be careful with the relative links due to the docs site using clean URLs (the link to the dashboard is also similarly broken at the end of the page).

We need to either:

  • add a check to ensure we can't land markdown docs with links that will break the docs site, or
  • update the docs site so it doesn't require a different URL format for relative links.

Thoughts @antgamdia , @ppbaena ?

@antgamdia
Copy link
Contributor

I'd rather avoid extra patches or checks, and directly go with what other projects are doing: either serving the docs via Github pages or set up a Netlify static site. But the key point is that we really should maintain a single repo, not a website and the main kubeapps repo separately (when they're using the same info).

Perhaps after these intense iterations, we could set some time for this in sept ?

@absoludity
Copy link
Contributor

+1 - that's what I meant with the second point.

@stale
Copy link

stale bot commented Aug 10, 2021

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.

@stale stale bot added the stale Automatic label to stale issues due inactivity to be closed if no further action label Aug 10, 2021
@ppbaena ppbaena added kind/bug An issue that reports a defect in an existing feature size/S and removed stale Automatic label to stale issues due inactivity to be closed if no further action size/S labels Aug 10, 2021
@ppbaena ppbaena self-assigned this Aug 19, 2021
@ppbaena
Copy link
Collaborator

ppbaena commented Aug 20, 2021

+1 to the second approach too.

@ppbaena ppbaena added this to the Technical debt milestone Sep 24, 2021
@ppbaena
Copy link
Collaborator

ppbaena commented Dec 14, 2021

Current https://kubeapps.com website will be deprecated and replaced by a new website fully integrated in the kubeapps repo as described in #3953

@ppbaena ppbaena closed this as completed Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug An issue that reports a defect in an existing feature kind/documentation An issue that reports an update related to project documentation
Projects
None yet
Development

No branches or pull requests

4 participants