weaveworks / weave-gitops

Weave GitOps provides insights into your application deployments, and makes continuous delivery with GitOps easier to adopt and scale across your teams.
https://docs.gitops.weave.works/
Apache License 2.0
899 stars 149 forks source link

old docs are still available and out of sync w/ published docs ("ghost pages") #3556

Closed foot closed 1 year ago

foot commented 1 year ago

Describe the bug

E.g. https://docs.gitops.weave.works/docs/0.6.0/cluster-management/getting-started/ — reports the latest version is 0.10.2

From @LappleApple, June 2023: We have several user guide pages showing up on the website that are not listed in the repository. @luizbafilho and I checked yesterday and were stumped. Maybe they live in the cloud. Let's make sure these do not appear in the left-side menu--they're confusing, bring up an inaccurate left-side page menu, and won't look great in Google searches.

We should perhaps clean up old file sitting around on in the docs bucket.

ACs:

LappleApple commented 1 year ago

+1 -- this cases lots of confusion.

yiannistri commented 1 year ago

https://docusaurus.io/docs/seo

LappleApple commented 1 year ago

I don't see how the current setup helps anyone -- it only causes confusion as we/they look for accurate, current, useable docs and end up going to old versions. After chatting with a few folks, here's a proposal:

Screenshot 2023-06-09 at 18 46 04

Shared this proposal with @joe-terrible and got a +1. Will collect some more feedback through next few days, and let's decide by mid next week.

LappleApple commented 1 year ago

And @lizwarner-weave, @bigkevmcd, @soschwei +1's

enekofb commented 1 year ago

+1

We have established a simple, clear process for storing the next-latest version of docs in the user docs area.

great adding this one

LappleApple commented 1 year ago

Hey @Himangini, how's it going? Let me know if you need anything. cc @yiannistri

Himangini commented 1 year ago

Hey @Himangini, how's it going? Let me know if you need anything. cc @yiannistri

@LappleApple I am working on it. :)

Himangini commented 1 year ago

@LappleApple @yiannistri I've opened a PR with the changes, PTAL https://github.com/weaveworks/weave-gitops/pull/3823

We should perhaps clean up old files sitting around on in the docs bucket.

We need a separate ticket for this. While deleting the requested files in our prod bucket I noticed there are a lot of old files still lying around and it's a pain to do this manually. Ideally, we need to add this to our docs workflow so we cleanup the bucket objects when new versions are published. Also, see comment here