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

fix comment syntax for correct website rendering #16916

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

hongshaoyang
Copy link
Contributor

@hongshaoyang hongshaoyang commented Apr 1, 2024

First-time contributors' checklist

What is changed, added or deleted? (Required)

TiDB docs website docs.pingcap.com does not support "#" as a comment. It shows as SQL code, which confuses readers:

image

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.

  • master (the latest development version)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added contribution This PR is from a community contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Apr 1, 2024
Copy link

ti-chi-bot bot commented Apr 1, 2024

Hi @hongshaoyang. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions 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/test-infra repository.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 1, 2024
Copy link

ti-chi-bot bot commented Apr 1, 2024

@hongshaoyang: GitHub didn't allow me to request PR reviews from the following users: ran-huang.

Note that only pingcap members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @ran-huang @songrijie @YangKeao @time-and-fate

Instructions 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/test-infra repository.

@Oreoxmt Oreoxmt self-assigned this Apr 1, 2024
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Apr 1, 2024

/ok-to-test

@ti-chi-bot ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Apr 1, 2024
@Oreoxmt Oreoxmt added translation/doing This PR's assignee is translating this PR. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. and removed ok-to-test Indicates a PR is ready to be tested. labels Apr 1, 2024
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Apr 1, 2024
@Oreoxmt Oreoxmt added missing-translation-status This PR does not have translation status info. needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. needs-cherry-pick-release-7.6 and removed missing-translation-status This PR does not have translation status info. labels Apr 1, 2024
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Apr 1, 2024
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Apr 1, 2024

@hongshaoyang Thanks for your contribution! Since TiDB supports using "#" or "--" to comment a line, could you please describe the reason for creating this PR?

@hongshaoyang
Copy link
Contributor Author

hongshaoyang commented Apr 1, 2024

@hongshaoyang Thanks for your contribution! Since TiDB supports using "#" or "--" to comment a line, could you please describe the reason for creating this PR?

TiDB docs website docs.pingcap.com does not support "#" as a comment. It shows as SQL code, which confuses readers:

Screenshot 2024-04-01 at 5 55 22 PM

@Oreoxmt Oreoxmt changed the title Update character-set-and-collation.md fix comment syntax for correct website rendering Apr 2, 2024
@Oreoxmt Oreoxmt removed the request for review from YangKeao April 2, 2024 02:41
@Oreoxmt Oreoxmt added translation/no-need No need to translate this PR. and removed translation/doing This PR's assignee is translating this PR. labels Apr 2, 2024
@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Apr 2, 2024

/ok-to-test

@ti-chi-bot ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Apr 2, 2024
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Apr 2, 2024
Copy link

ti-chi-bot bot commented Apr 2, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-04-01 08:45:51.137333015 +0000 UTC m=+260812.664873562: ☑️ agreed by Oreoxmt.
  • 2024-04-02 06:21:03.3994697 +0000 UTC m=+338524.927010246: ☑️ agreed by hfxsd.

@Oreoxmt
Copy link
Collaborator

Oreoxmt commented Apr 2, 2024

/approve

Copy link

ti-chi-bot bot commented Apr 2, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Oreoxmt

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Apr 2, 2024
@ti-chi-bot ti-chi-bot bot merged commit 0ee8395 into pingcap:master Apr 2, 2024
9 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.1: #16930.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.5: #16931.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-7.6: #16932.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.0: #16933.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved contribution This PR is from a community contributor. lgtm needs-cherry-pick-release-7.1 Should cherry pick this PR to release-7.1 branch. needs-cherry-pick-release-7.5 Should cherry pick this PR to release-7.5 branch. ok-to-test Indicates a PR is ready to be tested. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants