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

docs: Enables Docusaurus versioning for previous version of ICS docs #1442

Closed
wants to merge 2 commits into from

Conversation

mmulji-ic
Copy link
Contributor

Description

Part of docs Epic cosmos/gaia#2309.

This PR enables multiple versions of the Interchain Security docs to be displayed upon deployment.
Note: Limited the number of docs, as previous versions of docs were raw markdown and did not have a Docusaurus installation.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@mmulji-ic mmulji-ic requested a review from a team as a code owner November 21, 2023 13:47
@mmulji-ic mmulji-ic self-assigned this Nov 22, 2023
Copy link
Contributor

@p-offtermatt p-offtermatt left a comment

Choose a reason for hiding this comment

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

Left one comment. Also, the versioning doesn't work locally for me - v3.1.0 is not selectable

@@ -0,0 +1,5 @@
[
"v3.1.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add a reminder to add new releases here to https://github.com/cosmos/interchain-security/blob/main/RELEASE_PROCESS.md?

@p-offtermatt
Copy link
Contributor

This is still broken for me - the dropdown under the version has both Next and v3.1.0.
They are the same, appearantly, and clicking v3.1.0 just brings me to Next.
It's weird, because it seems like clicking v3.1.0 when currently on Next is broken, as it does nothing.

This is not what I'd exect - I'd expect v3.1.0 to not be listed at all if it only redirects to Next anyways, and just have Next and old versions,
i.e. see the sdk docs - https://docs.cosmos.network/main/learn. Every version is clickable from every other version.

@mmulji-ic
Copy link
Contributor Author

After the Docusaurus deps bump, seems only main and release/v4.0.x branches are compatible content wise.
Alas, Docusaurus doesn't like any release/* branches either. Therefore, will leave this PR open, until we have another compatible branch to test. I don't want to updates deps in previous release branches.

@mmulji-ic
Copy link
Contributor Author

@MSalopek has another version under review

@mmulji-ic mmulji-ic closed this Mar 7, 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

Successfully merging this pull request may close these issues.

2 participants