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

Refactor extensions docs to enable versioning #12355

Merged
merged 3 commits into from
Nov 4, 2024

Conversation

jordojordo
Copy link
Member

@jordojordo jordojordo commented Oct 24, 2024

Summary

Fixes #12357

With the upcoming changes to the extension documentation, the existing docs should be versioned as they pertain to older versions of @rancher/shell and older versions of Rancher that extension developers may still want to write extensions for.

Occurred changes and/or fixed issues

  • Added versioning for the Extensions documentation
  • Created one version for 2.0.x relating to @rancher/shell version 2.0.x
  • Refactored sidebars to fit new structure

Technical notes summary

Areas or cases that should be tested

  • Visiting extension docs, internal docs, and blog
  • Switch the version for the extension docs

Areas which could experience regressions

Screenshot/Video

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes

@aalves08 aalves08 requested review from aalves08 and removed request for aalves08 October 24, 2024 15:08
@aalves08 aalves08 added this to the v2.10.0 milestone Oct 24, 2024
@aalves08 aalves08 self-assigned this Oct 24, 2024
@nwmac nwmac added the shell PRs/Issues that relate to a shell release rather than being needed for a dashboard release label Oct 29, 2024
Copy link
Member

@aalves08 aalves08 left a comment

Choose a reason for hiding this comment

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

Got a look at this and it works and builds fine. Just one small thing:

  1. Can we set next to 3.x.x? Seems the appropriate label, imho
Screenshot 2024-10-30 at 15 18 51

@jordojordo
Copy link
Member Author

We can do that, we'll just have to remember to change the "next" version label whenever we update things past version 3 of course.

@jordojordo jordojordo requested a review from aalves08 November 1, 2024 16:35
Copy link
Member

@aalves08 aalves08 left a comment

Choose a reason for hiding this comment

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

LGTM

@aalves08 aalves08 merged commit dd0b605 into rancher:master Nov 4, 2024
31 checks passed
@jordojordo jordojordo deleted the version-docs branch November 4, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
shell PRs/Issues that relate to a shell release rather than being needed for a dashboard release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create versioning of extensions documentation
3 participants