kubeshop / botkube-docs

Docs for botkube.io
https://botkube.io
MIT License
8 stars 23 forks source link

Simplify version switcher and add "All versions" page #267

Closed yo-404 closed 1 year ago

yo-404 commented 1 year ago

Fixes 257

Description

Changes proposed in this pull request:

Testing

Changes

image image

files added

Future Improvements

-Automation of the following - moving of last version from versions.json to versionsArchived.json along with URL on new release .

pkosiec commented 1 year ago

Hey @yo-404, I'll check your PR in ~2-3hrs. In the meantime please try to run npm run lint:fix. Thanks!

pkosiec commented 1 year ago

I see that you got:

Map(1) { '/0.18/usage/filters/' => false }
Error:  Unable to build website for locale en.
Error:  Error: You are trying to create client-side redirections to invalid paths.

It's in the https://github.com/kubeshop/botkube-docs/blob/main/redirects.js. Could you point to from /filters to /configuration/source/kubernetes#filters? This should solve the issue, you can verify by npm run build. Thanks!

yo-404 commented 1 year ago

sure

yo-404 commented 1 year ago

Hi @pkosiec , Thanks for your guidance , I have done the above changes

2 issues present right now -

It's in the https://github.com/kubeshop/botkube-docs/blob/main/redirects.js. Could you point to from /filters to /configuration/source/kubernetes#filters

tried this , but it is not a valid path now as we have removed that certain version from versions.json and the above path does not exist in the current version path .

Exhaustive list of all broken links found: On source page path = /1.0/installation/slack/: -> linking to /0.14/installation/slack/

Same goes for this , Another page pointing to path of an older version doc .

in order to use the docsdropdown as our version dropdown we will have to remove the older versions from versions.json

possible solutions

pkosiec commented 1 year ago

Hey @yo-404, Thank you for the changes. Could you push them? I don't see any updates on the PR 🤔 And yes, we should change the links. Weird that the /configuration/source/kubernetes#filters doesn't work. Let me check that on Monday - I'll try to fix it 👍 Have a nice weekend!

pkosiec commented 1 year ago

Thank you @yo-404 🙇 I'll handle the redirections and let you know after that 👍 I'll push one or a few commits to this PR.

yo-404 commented 1 year ago

Thank you so much for your guidance @pkosiec 💚. Looking forward to learn and contribute more to the community