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 backporting gaps to prevent old docs versions from showing up in search #3993

Merged
merged 15 commits into from
Sep 8, 2023

Conversation

lasomethingsomething
Copy link
Contributor

@lasomethingsomething lasomethingsomething commented Sep 7, 2023

What changed?

This PR aims to close the backporting gap between v0.24.0 and v0.25.0 that is causing people to end up in the v0.24.0 version of the docs via searches.

Why was this change made?

So users don't get taken to old user docs pages.

How was this change implemented?

This updates v0.24.0 to include URLs, file names, sidebar references, and link updates made in v0.25.0.

How did you validate the change?

Ran yarn start a bunch of times until I got a clean result.

Documentation Changes

It's all about doc changes.

Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lauri,

what is the user flow where they end up in v0.24:

  • user goes to docs and click search, finds something -> click -> goes to v0.24 version -> docs not found or
  • something else?

Btw, it seems there is some build issue see here https://github.com/weaveworks/weave-gitops/actions/runs/6112250021/job/16589310309

@lasomethingsomething
Copy link
Contributor Author

@enekofb The user flow is that a person will either come to the old pages through Google search or end up on these old pages after clicking inside our docs and unexpectedly being taken there. I'm aware of the build issues, I attributed it to this being a change affecting docs from several releases ago and was waiting till today to ask for insight/help in resolving.

@enekofb
Copy link
Contributor

enekofb commented Sep 8, 2023

I'm aware of the build issues, I attributed it to this being a change affecting docs from several releases ago and was waiting till today to ask for insight/help in resolving.

not sure if useful, but have raised an example of link fix here

in case you want to review how to view and fix them locally (in case you are not familiar) feel free to ping me

Copy link
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions were added on the links. I definitely support not doing backporting changes going forward unless there in special occasions.

Lauri Apple and others added 4 commits September 8, 2023 16:33
@lasomethingsomething lasomethingsomething merged commit c812ffd into main Sep 8, 2023
@lasomethingsomething lasomethingsomething deleted the docs-changes-sept8 branch September 8, 2023 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants