dashboard: permissions for setting up SSO #21837
Conversation
Summary of ChangesHello @dveeden, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for TiDB Dashboard's Single Sign-On (SSO) feature by adding important information regarding the permissions required to configure SSO. The update ensures users are fully aware of the prerequisites for enabling the SSO option within the dashboard. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a helpful note to the SSO documentation, clarifying that the SYSTEM_VARIABLES_ADMIN permission is required to enable the feature. My review provides suggestions to refine the wording for better clarity and to ensure it aligns with the project's documentation style guide, such as using the second person and present tense.
dashboard/dashboard-session-sso.md
Outdated
|
|
||
| > **Note:** | ||
| > | ||
| > The **Enable to use SSO when sign into TiDB Dashboard** option will be greyed out if the account doesn't have the `SYSTEM_VARIABLES_ADMIN` permission. See [TiDB Dashboard User Management](/dashboard/dashboard-user.md) for more details on permissions. |
There was a problem hiding this comment.
Thanks for adding this helpful note. To improve clarity and align with the documentation style guide, I suggest a few revisions:123
- Use second person: Address the user as "you" (e.g., "if your account does not have...").
- Use present tense: The option "is grayed out", not "will be greyed out".
- Formatting: UI option names should be in backticks, not bold.
- Wording: "signing in to" is preferred over "sign into" for grammatical correctness and consistency across the documentation.
Here is a suggested update:
| > The **Enable to use SSO when sign into TiDB Dashboard** option will be greyed out if the account doesn't have the `SYSTEM_VARIABLES_ADMIN` permission. See [TiDB Dashboard User Management](/dashboard/dashboard-user.md) for more details on permissions. | |
| > The `Enable to use SSO when signing in to TiDB Dashboard` option is grayed out if your account does not have the `SYSTEM_VARIABLES_ADMIN` permission. For more details on permissions, see [TiDB Dashboard User Management](/dashboard/dashboard-user.md). |
Style Guide References
Footnotes
-
The style guide recommends addressing users in the second person ('you'). The current text uses 'the account', which can be improved by changing it to 'your account'. ↩
-
The style guide prefers using the present tense. The phrase 'will be greyed out' should be changed to the present tense 'is grayed out'. ↩
-
According to the style guide, UI option names should be enclosed in backticks for consistency. The option name should be changed from bold to backticked. ↩
|
cc @kissmydb |
qiancai
added
needs-cherry-pick-release-8.1
ti-chi-bot
bot
added
lgtm
and removed
needs-1-more-lgtm
[LGTM Timeline notifier]Timeline:
|
qiancai
added
type/enhancement
qiancai
added
translation/done
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
|
In response to a cherrypick label: new pull request created to branch |
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?