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.

Sign up for GitHub

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

Jump to bottom

dev guide: fix a render issue #12586

Merged
merged 1 commit into from
Feb 20, 2023
Merged

dev guide: fix a render issue #12586

merged 1 commit into from
Feb 20, 2023

Conversation

Oreoxmt
Copy link
Collaborator

@Oreoxmt Oreoxmt commented Feb 20, 2023

What is changed, added or deleted? (Required)

The following list with CustomContent is rendered as two unordered lists in documentation website:

- [Quick Start](/develop/dev-guide-build-cluster-in-cloud.md)
- [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)

<CustomContent platform="tidb">

- [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md)

</CustomContent>

- [Database Schema Design](/develop/dev-guide-schema-design-overview.md)
- [Write Data](/develop/dev-guide-insert-data.md)
- [Read Data](/develop/dev-guide-get-data-from-single-table.md)
- [Transaction](/develop/dev-guide-transaction-overview.md)
- [Optimize](/develop/dev-guide-optimize-sql-overview.md)
- [Example Applications](/develop/dev-guide-sample-application-spring-boot.md)

In TiDB documentation, the content is:

- [Quick Start](/develop/dev-guide-build-cluster-in-cloud.md)
- [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)


- [Connect to TiDB](/develop/dev-guide-connect-to-tidb.md)


- [Database Schema Design](/develop/dev-guide-schema-design-overview.md)
- [Write Data](/develop/dev-guide-insert-data.md)
- [Read Data](/develop/dev-guide-get-data-from-single-table.md)
- [Transaction](/develop/dev-guide-transaction-overview.md)
- [Optimize](/develop/dev-guide-optimize-sql-overview.md)
- [Example Applications](/develop/dev-guide-sample-application-spring-boot.md)

and is rendered as:

image

In TiDB Cloud documentation, the content is:

- [Quick Start](/develop/dev-guide-build-cluster-in-cloud.md)
- [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md)


- [Database Schema Design](/develop/dev-guide-schema-design-overview.md)
- [Write Data](/develop/dev-guide-insert-data.md)
- [Read Data](/develop/dev-guide-get-data-from-single-table.md)
- [Transaction](/develop/dev-guide-transaction-overview.md)
- [Optimize](/develop/dev-guide-optimize-sql-overview.md)
- [Example Applications](/develop/dev-guide-sample-application-spring-boot.md)

and is rendered as:

image

This PR uses two CustomContent tags for TiDB and TiDB Cloud content.

TiDB preview:

image

TiDB Cloud preview:

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)
  • v6.6 (TiDB 6.6 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.4 (TiDB 6.4 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

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

@Oreoxmt
dev guide: fix a render issue
213be50 
Signed-off-by: Aolin <aolin.zhang@pingcap.com>
@Oreoxmt Oreoxmt added type/bugfix This PR fixes a bug. translation/no-need No need to translate this PR. area/develop This PR relates to the area of TiDB App development. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-cherry-pick-release-6.6 labels Feb 20, 2023
@Oreoxmt Oreoxmt requested a review from lilin90 February 20, 2023 08:41
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Feb 20, 2023 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • lilin90

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 20, 2023
lilin90
lilin90 approved these changes Feb 20, 2023
View reviewed changes
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Feb 20, 2023
@Oreoxmt Oreoxmt added the require-LGT1 Indicates that the PR requires an LGTM. label Feb 20, 2023
@Oreoxmt
Copy link
Collaborator Author

Oreoxmt commented Feb 20, 2023

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 213be50

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Feb 20, 2023
@ti-chi-bot ti-chi-bot merged commit 8e3e40f into pingcap:master Feb 20, 2023
@Oreoxmt Oreoxmt deleted the fix/develop-overview branch February 20, 2023 08:53
@ti-chi-bot ti-chi-bot mentioned this pull request Feb 20, 2023
Merged
14 tasks
@ti-chi-bot
Copy link
Member

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

@ti-chi-bot ti-chi-bot mentioned this pull request Feb 20, 2023
Merged
14 tasks
@ti-chi-bot
Copy link
Member

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

ti-chi-bot added a commit that referenced this pull request Feb 20, 2023
@ti-chi-bot
dev guide: fix a render issue (#12586) (#12590)
7c34489
ti-chi-bot added a commit that referenced this pull request Feb 20, 2023
@ti-chi-bot
dev guide: fix a render issue (#12586) (#12589)
d58d84e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lilin90 lilin90 lilin90 approved these changes

Assignees
No one assigned
Labels
area/develop This PR relates to the area of TiDB App development. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. require-LGT1 Indicates that the PR requires an LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. translation/no-need No need to translate this PR. type/bugfix This PR fixes a bug.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Oreoxmt @ti-chi-bot @lilin90