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

doc: Use collapsed blocks to make it more friendly for readers #4370

Merged
merged 7 commits into from
Mar 29, 2022
Merged

doc: Use collapsed blocks to make it more friendly for readers #4370

merged 7 commits into from
Mar 29, 2022

Conversation

breezewish
Copy link
Member

@breezewish breezewish commented Mar 21, 2022 •
edited by JaySon-Huang
Loading

What problem does this PR solve?

Issue Number: ref #4019

Problem Summary: Polish the README to make it more friendly for readers, since a reader will only need to reveal one of these collapsed blocks and will not be disturbed by others.

Rendered Doc

What is changed and how it works?

README.

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

None

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Mar 21, 2022 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • LittleFall
  • SchrodingerZhu

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 do-not-merge/needs-linked-issue release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 21, 2022
@breezewish
doc: Use collapsed blocks to make it more friendly for readers
2df01e7 
Signed-off-by: Wish <breezewish@pingcap.com>
@breezewish breezewish force-pushed the wenxuan/readme-polish branch from b8d3813 to 2df01e7 Compare March 21, 2022 15:58
@breezewish breezewish requested a review from zanmato1984 March 21, 2022 16:00
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Mar 21, 2022
breezewish and others added 2 commits March 22, 2022 00:04
@breezewish
doc: Remove duplicated Rustup instructions in Linux
a658154 
Signed-off-by: Wish <breezewish@pingcap.com>
@breezewish
doc: polish
5192e97 
Signed-off-by: Wish <breezewish@outlook.com>
@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Mar 22, 2022
fuzhe1989
fuzhe1989 approved these changes Mar 22, 2022
View reviewed changes
Copy link
Contributor

@fuzhe1989 fuzhe1989 left a comment

Choose a reason for hiding this comment

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

great job!

@JaySon-Huang
Copy link
Contributor

What about making the "Build with System Libraries" part to be collapsed by default?

@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 27, 2022
@ti-chi-bot ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 28, 2022
@JaySon-Huang
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

@JaySon-Huang: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

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 ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

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

Commit hash: 5ef0f71

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 28, 2022
@sre-bot
Copy link
Collaborator

sre-bot commented Mar 28, 2022

Coverage for changed files

no c/c++ source change detected

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17049      9575             43.84%    191774  96998        49.42%

full coverage report (for internal network access only)

@breezewish breezewish force-pushed the wenxuan/readme-polish branch from 5ef0f71 to b21b22e Compare March 28, 2022 03:32
@ti-chi-bot ti-chi-bot removed the status/can-merge Indicates a PR has been approved by a committer. label Mar 28, 2022
@breezewish
Update sub-module to a1ff
87f8416 
Signed-off-by: Wish <breezewish@outlook.com>
@breezewish
Copy link
Member Author

breezewish commented Mar 28, 2022 •
edited
Loading

@JaySon-Huang I have updated the doc to collapse the "Build with System Libraries" part. PTAL again, thanks.

JaySon-Huang
JaySon-Huang approved these changes Mar 28, 2022
View reviewed changes
Copy link
Contributor

@JaySon-Huang JaySon-Huang left a comment

Choose a reason for hiding this comment

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

LGTM

@JaySon-Huang
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

@JaySon-Huang: It seems you want to merge this PR, I will help you trigger all the tests:

/run-all-tests

You only need to trigger /merge once, and if the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

If you have any questions about the PR merge process, please refer to pr process.

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 ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

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

Commit hash: 87f8416

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Mar 29, 2022
@sre-bot
Copy link
Collaborator

sre-bot commented Mar 29, 2022

Coverage for changed files

no c/c++ source change detected

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17049      9575             43.84%    191774  97000        49.42%

full coverage report (for internal network access only)

@sre-bot
Copy link
Collaborator

sre-bot commented Mar 29, 2022

Coverage for changed files

no c/c++ source change detected

Coverage summary

Functions  MissedFunctions  Executed  Lines   MissedLines  Cover
17050      9576             43.84%    191811  97032        49.41%

full coverage report (for internal network access only)

@ti-chi-bot ti-chi-bot merged commit 6899e2f into master Mar 29, 2022
@JaySon-Huang JaySon-Huang deleted the wenxuan/readme-polish branch March 29, 2022 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fuzhe1989 fuzhe1989 fuzhe1989 approved these changes

@JaySon-Huang JaySon-Huang JaySon-Huang approved these changes

@solotzg solotzg solotzg approved these changes

@SchrodingerZhu SchrodingerZhu SchrodingerZhu approved these changes

@LittleFall LittleFall LittleFall approved these changes

@zanmato1984 zanmato1984 Awaiting requested review from zanmato1984

Assignees
No one assigned
Labels
release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@breezewish @ti-chi-bot @JaySon-Huang @sre-bot @fuzhe1989 @solotzg @SchrodingerZhu @LittleFall