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

readme, contributing: rewrite contribution resources #1899

Merged
merged 7 commits into from
Feb 28, 2020

Conversation

lilin90
Copy link
Member

@lilin90 lilin90 commented Feb 28, 2020

What is changed, added or deleted?

  • Rewrite README.md to make it more like a docs readme (replace simply intro to TiDB)
  • Rewrite CONTRIBUTING.md to add more resources

Note: Markdownlint rules will be added to a separate file (in resources) later in another PR.

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

Important Notice:

If your changes apply to multiple TiDB documentation versions, to trigger the bot to cherry-pick this PR to other release branches, make sure you add labels such as:

  • needs-cherry-pick-3.0
  • needs-cherry-pick-3.1
  • needs-cherry-pick-2.1

@lilin90 lilin90 added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. needs-cherry-pick-2.1 labels Feb 28, 2020
@lilin90 lilin90 requested a review from yikeke February 28, 2020 10:32
@lilin90 lilin90 added the requires-followup This PR requires a follow-up task after being merged. label Feb 28, 2020
@lilin90
Copy link
Member Author

lilin90 commented Feb 28, 2020

@kolbe FYI.

@lilin90 lilin90 added the size/large Changes of a large size. label Feb 28, 2020
Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM

@lilin90 lilin90 merged commit cb42aa9 into pingcap:master Feb 28, 2020
@lilin90 lilin90 deleted the update-readme-contribute branch February 28, 2020 14:17
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Feb 28, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording
@sre-bot
Copy link
Contributor

sre-bot commented Feb 28, 2020

cherry pick to release-2.1 in PR #1904

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Feb 28, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording
@sre-bot
Copy link
Contributor

sre-bot commented Feb 28, 2020

cherry pick to release-3.0 in PR #1905

sre-bot pushed a commit to sre-bot/docs that referenced this pull request Feb 28, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording
@sre-bot
Copy link
Contributor

sre-bot commented Feb 28, 2020

cherry pick to release-3.1 in PR #1906

lilin90 added a commit that referenced this pull request Feb 29, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording

Co-authored-by: Lilian Lee <lilin@pingcap.com>
lilin90 added a commit that referenced this pull request Feb 29, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording

Co-authored-by: Lilian Lee <lilin@pingcap.com>
@lilin90 lilin90 removed the requires-followup This PR requires a follow-up task after being merged. label Mar 4, 2020
sticnarf pushed a commit to sticnarf/docs that referenced this pull request Mar 20, 2020
* readme, contributing: rewrite contribution resources

* contributing: update url format

* contributing: add more descriptions

* contributing: update wording
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/large Changes of a large size. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants