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

Developer docs refer to incorrect password info #10740

Closed
martyav opened this issue Apr 2, 2024 · 2 comments · Fixed by #11464
Closed

Developer docs refer to incorrect password info #10740

martyav opened this issue Apr 2, 2024 · 2 comments · Fixed by #11464
Assignees
Labels
kind/enhancement kind/tech-debt Technical debt size/0.5 Size Estimate 0.5
Milestone

Comments

@martyav
Copy link
Contributor

martyav commented Apr 2, 2024

Is your feature request related to a problem? Please describe.
While researching information about the Rancher admin and bootstrap passwords for the Rancher docs, I found https://github.com/rancher/dashboard/blob/master/docusaurus/docs/code-base-works/auth-sessions-and-tokens.md. I don't know about the history or visibility of this page, but it claims that the password can't match the username. According to rancher/rancher-docs#1208 (comment), the password merely needs to fulfill the minimum length requirement. It's still not clear to me if the minimum length value is alterable to users in current versions of Rancher. Finally, the bootstrap password is a special case and doesn't need to meet the minimum length requirement after all (rancher/rancher-docs#1208 (comment))

Describe the solution you'd like

If https://github.com/rancher/dashboard/blob/master/docusaurus/docs/code-base-works/auth-sessions-and-tokens.md is visible to users, we should definitely update it, as the information is misleading and not in sync with https://ranchermanager.docs.rancher.com/.

Describe alternatives you've considered

Additional context

I'm currently working on rancher/rancher-docs#1208 for https://ranchermanager.docs.rancher.com/, so if there are any corrections or omissions for the admin/bootstrap password, feel free to help.

@github-actions github-actions bot added [zube]: To Triage QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this labels Apr 2, 2024
@rak-phillip
Copy link
Member

@martyav The document in questions is accessible via our developer docs1. I'm thinking that it might suffice to simply link to the Rancher password requirements instead of detailing them ourselves. This can cut down on duplication while still allowing us to effectively convey our message.

Footnotes

  1. https://rancher.github.io/dashboard/code-base-works/auth-sessions-and-tokens

@gaktive gaktive added this to the v2.9.0 milestone Apr 4, 2024
@gaktive gaktive modified the milestones: v2.9.0, v2.10.0 Apr 15, 2024
@nwmac nwmac modified the milestones: v2.10.0, v2.11.0 Jul 4, 2024
@gaktive gaktive added the kind/tech-debt Technical debt label Jul 4, 2024
@gaktive gaktive changed the title https://github.com/rancher/dashboard/blob/master/docusaurus/docs/code-base-works/auth-sessions-and-tokens.md incorrect? Developer docs refer to incorrect password info Jul 4, 2024
@nwmac nwmac modified the milestones: v2.11.0, v2.10.0 Jul 9, 2024
@kwwii
Copy link
Contributor

kwwii commented Jul 10, 2024

@gaktive gaktive added the size/0.5 Size Estimate 0.5 label Jul 10, 2024
@momesgin momesgin self-assigned this Jul 16, 2024
@momesgin momesgin removed the QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this label Jul 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement kind/tech-debt Technical debt size/0.5 Size Estimate 0.5
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants