Skip to content

Add Tokens example workflows page #1839

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

Merged
merged 9 commits into from
Jul 23, 2025

Conversation

andreas-kupries
Copy link

Fixes #1630

Reminders

  • See the README for more details on how to work with the Rancher docs.

  • Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.

  • If the pull request is dependent on an upcoming release, remember to add a "MERGE ON RELEASE" label and set the proper milestone.

Description

Add an example workflows page for the new Imperative API resource Tokens that is coming with Rancher v2.12.0.

Comments

Copy link
Contributor

@pmkovar pmkovar left a comment

Choose a reason for hiding this comment

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

Thanks for the PR.

@pmkovar pmkovar added DO NOT MERGE MERGE ON RELEASE Don't merge until the moment the next release publishes labels Jun 24, 2025
@sunilarjun sunilarjun changed the base branch from main to v2.12.0 July 11, 2025 22:03
Copy link
Contributor

@sunilarjun sunilarjun left a comment

Choose a reason for hiding this comment

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

Hello @andreas-kupries thank you for the page addition! I've left some review comments addressing some style/contents, and also are you able to rebase and add these changes to the v2.12 versioned_docs folder?

Additionally, the sidebars.js and versioned_sidebars/version-2.12-sidebars.json files need to be updated in order for the page to display and be clickable from the left navigation. Essentially "api/workflows/tokens" needs to be added to the sidebars.js file at line 1360, and similarly in the versioned_sidebars/version-2.12-sidebars.json file.

Please let me know if you need any help and I can definitely assist in updating the sidebars files as well, thanks!

@andreas-kupries andreas-kupries force-pushed the token-example-workflows branch from 0d692bf to 4cd310a Compare July 14, 2025 10:57
@andreas-kupries
Copy link
Author

Hello @andreas-kupries thank you for the page addition! I've left some review comments addressing some style/contents,

Accepted.

and also are you able to rebase and add these changes to the v2.12 versioned_docs folder?

Rebased to main now, and done the 2.12 changes, including the sidebars mentioned below.

Commit 4cd310a

Additionally, the sidebars.js and versioned_sidebars/version-2.12-sidebars.json files need to be updated in order for the page to display and be clickable from the left navigation. Essentially "api/workflows/tokens" needs to be added to the sidebars.js file at line 1360, and similarly in the versioned_sidebars/version-2.12-sidebars.json file.

Please let me know if you need any help and I can definitely assist in updating the sidebars files as well, thanks!

Copy link
Contributor

@LucasSaintarbor LucasSaintarbor left a comment

Choose a reason for hiding this comment

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

Removed an extra space and changed the H4s to H2s so they show up the right side nav and align with Projects page.

Screenshot 2025-07-15 at 11 07 15 AM Screenshot 2025-07-15 at 11 07 30 AM

@btat btat added the port/community-product Triggers a GitHub action to file a community sync issue for rancher-product-docs. label Jul 15, 2025
sunilarjun
sunilarjun previously approved these changes Jul 16, 2025
Copy link
Contributor

@sunilarjun sunilarjun left a comment

Choose a reason for hiding this comment

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

Approving wrt my changes being addressed, thank you!

@btat btat removed DO NOT MERGE MERGE ON RELEASE Don't merge until the moment the next release publishes labels Jul 21, 2025
@btat btat added this to the v2.12.0 milestone Jul 21, 2025
Copy link
Contributor

@LucasSaintarbor LucasSaintarbor left a comment

Choose a reason for hiding this comment

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

@andreas-kupries Requesting some grammar/style changes. Thanks!

@andreas-kupries
Copy link
Author

Latest comments addressed. Also rebased to resolve conflict with kubeconfig work.

Copy link
Contributor

@LucasSaintarbor LucasSaintarbor left a comment

Choose a reason for hiding this comment

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

@andreas-kupries Thanks for applying the changes! LGTM.

Copy link
Contributor

@LucasSaintarbor LucasSaintarbor left a comment

Choose a reason for hiding this comment

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

@andreas-kupries Should not have approved just yet, to clean up the commit history, may you rebase against the https://github.com/rancher/rancher-docs/tree/v2.12.0 branch instead of main?

@btat btat changed the base branch from v2.12.0 to main July 23, 2025 18:29
@btat btat dismissed sunilarjun’s stale review July 23, 2025 18:29

The base branch was changed.

@btat btat changed the base branch from main to v2.12.0 July 23, 2025 18:29
@LucasSaintarbor LucasSaintarbor changed the base branch from v2.12.0 to main July 23, 2025 18:30
@LucasSaintarbor LucasSaintarbor changed the base branch from main to v2.12.0 July 23, 2025 18:30
@LucasSaintarbor LucasSaintarbor changed the base branch from v2.12.0 to main July 23, 2025 18:31
@LucasSaintarbor LucasSaintarbor changed the base branch from main to v2.12.0 July 23, 2025 18:32
@btat btat force-pushed the token-example-workflows branch from b1633cb to a5ddef9 Compare July 23, 2025 18:53
@LucasSaintarbor
Copy link
Contributor

@andreas-kupries Should not have approved just yet, to clean up the commit history, may you rebase against the https://github.com/rancher/rancher-docs/tree/v2.12.0 branch instead of main?

@andreas-kupries No need to rebase @btat took care of it.

@btat btat merged commit ddb4f72 into rancher:v2.12.0 Jul 23, 2025
1 check passed
@btat btat mentioned this pull request Jul 23, 2025
@andreas-kupries
Copy link
Author

@andreas-kupries Should not have approved just yet, to clean up the commit history, may you rebase against the https://github.com/rancher/rancher-docs/tree/v2.12.0 branch instead of main?

@andreas-kupries No need to rebase @btat took care of it.

After first reading the above I thought that I had rebased to 2.12 in my latest push.
Then I realized that it was maybe the base branch of the PR which was wrong, i.e. while the PR was structurally on 2.12 it compared to main instead of 2.12. This I had not checked for. So thanks for fixing that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
port/community-product Triggers a GitHub action to file a community sync issue for rancher-product-docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Public API Tokens
6 participants