update docs for lark support bot#22425
update docs for lark support bot#22425Yujie-Xie wants to merge 5 commits intopingcap:release-8.1from
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
contribution
|
Hi @Yujie-Xie. Thanks for your PR. I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
ti-chi-bot
bot
added
missing-translation-status
Summary of ChangesHello @Yujie-Xie, 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 updates the documentation for the TiDB Cloud connected Lark ticket system. The changes reflect a streamlined process for creating support tickets and enhanced interaction capabilities for Premium support plan subscribers. The documentation has been updated with new screenshots and descriptions to accurately represent the current functionality. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
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
|
![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 updates the documentation for creating and interacting with support tickets via Lark, reflecting a new workflow. My review focuses on improving clarity, conciseness, and consistency in accordance with the repository's documentation style guide. I have provided suggestions to correct grammar, avoid passive voice, and reduce repetition to ensure the instructions are clear and easy for users to follow.
|  | ||
|
|
||
| Fill in the required fields and click **Submit**. Once submitted, the card will be updated to **Ticket Submitted**, indicating that your request is being processed. | ||
| Fill in the card according to your actual problem, and then click **Submit** to submit the ticket. |
There was a problem hiding this comment.
To make the instruction more concise and avoid the repetition of "submit", I suggest rephrasing this sentence.
| Fill in the card according to your actual problem, and then click **Submit** to submit the ticket. | |
| Fill in the card with your problem details, and then click **Submit**. |
References
- Avoid unnecessary words and repetition. (link)
|  | ||
|
|
||
| When a PingCAP support engineer comments on the ticket, the comment will be automatically synchronized to the thread. | ||
| Fill in the card according to your actual problem, and then click **Submit** to submit the ticket. |
There was a problem hiding this comment.
To make the instruction more concise and avoid the repetition of "submit", I suggest rephrasing this sentence.
| Fill in the card according to your actual problem, and then click **Submit** to submit the ticket. | |
| Fill in the card with your problem details, and then click **Submit**. |
References
- Avoid unnecessary words and repetition. (link)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
| ## Subscribe to ticket updates | ||
|
|
||
| Whenever a PingCAP support engineer comments on the ticket, **PingCAP Support Bot** will send a **New Comment on Your Ticket** card to the Lark group. | ||
| For customers in the **Enterprise** support plan, you can also subscribe to ticket updates in Lark. When a support engineer responds to a ticket, an update message is posted in the **PingCAP Support Group** of Lark. The message includes the ticket title, ticket link, and the latest comment content. |
There was a problem hiding this comment.
TBD: an update message is posted in the PingCAP Support Group of Lark
| @@ -13,13 +13,25 @@ For customers subscribed to the **Premium** [support plan](/tidb-cloud/connected | |||
|
|
|||
| ## Interact with support tickets | |||
There was a problem hiding this comment.
If a ticket is not created via Lark, can customers interact with it via Lark?
|
|
||
| When anyone comments in the thread, the comment will be synchronized back to the corresponding support ticket. | ||
|  | ||
|
|
There was a problem hiding this comment.
Line 16~22 can be removed (as this doc focus on ticket interaction, not creation)
| When anyone comments in the thread, the comment will be synchronized back to the corresponding support ticket. | ||
|  | ||
|
|
||
| After successfully creating the ticket, the bot will reply with the ticket link in the thread. |
There was a problem hiding this comment.
| After successfully creating the ticket, the bot will reply with the ticket link in the thread. | |
| In the **PingCAP Support Group** of Lark, after you [create a support ticket](/tidb-cloud/connected-lark-ticket-creation.md#create-a-support-ticket), the bot replies with the ticket link in the message thread. |
| The support engineer's comments on the ticket will be synchronized to the Lark message thread, so you do not need to go to the support portal to view them. You can reply directly in this message thread, and your replies will also be synchronized to the ticket system. | ||
|
|
||
| In this way, customers subscribed to the **Premium** support plan can quickly create, respond, and manage tickets without leaving Lark. |
There was a problem hiding this comment.
| The support engineer's comments on the ticket will be synchronized to the Lark message thread, so you do not need to go to the support portal to view them. You can reply directly in this message thread, and your replies will also be synchronized to the ticket system. | |
| In this way, customers subscribed to the **Premium** support plan can quickly create, respond, and manage tickets without leaving Lark. | |
| When a support engineer responds to the ticket, the response will be synchronized to the Lark message thread, so you do not need to visit the support portal to view them. You can reply directly in the same message thread, and your replies will also be synchronized to the ticket system. | |
| With this capability, customers subscribed to the **Premium** support plan can quickly create, respond to, and manage tickets without leaving Lark. |
[LGTM Timeline notifier]Timeline:
|
2 participants
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?