search

tikv / website

Website for tikv.org
19 stars 62 forks source link

add document for v5.1: Get started using TiKV in 5 Minutes #224

Closed marsishandsome closed 3 years ago

marsishandsome commented 3 years ago

What is changed?

TiKV's official website is planned to be refactored as discussed in https://github.com/tikv/website/issues/227.

This PR is the start of the refactor work:

  1. add document folder for v5.1
  2. add doc tree for Get Started
  3. add document Get started using TiKV in 5 Minutes

Any related PRs or issues?

https://github.com/tikv/website/issues/227

Which version does your change affect?

v5.1

marsishandsome commented 3 years ago

/run-all-tests

marsishandsome commented 3 years ago

@zz-jason @andylokandy PTAL again

marsishandsome commented 3 years ago

@dcalvin @andylokandy @zz-jason PTAL

zz-jason commented 3 years ago

some suggestions:

  1. https://docs.google.com/document/d/1TVrPOk26rmC6Jrhj8MO9vWlOwlTTfq83ZUgfe5WHe4E/edit is only visible to PingCAP employees. It's better to file a Github issue to descript the background, the new doc tree, the plan to complement the new doc tree. Then you can link each related PR to that issue.

  2. All the dev documents in the old content are deleted, which is a big change. After going through the current doc tree, I think we can firstly adding new sections like "Get Started", "Develop", and "Deployment", after the new sections are added, we can remove the old sections safely.

marsishandsome commented 3 years ago

2. All the dev documents in the old content are deleted, which is a big change. After going through the current doc tree, I think we can firstly adding new sections like "Get Started", "Develop", and "Deployment", after the new sections are added, we can remove the old sections safely.

what about putting the new document in 5.0 folder or 5.0-dev folder (do not affect the dev folder) ?

zz-jason commented 3 years ago
  1. All the dev documents in the old content are deleted, which is a big change. After going through the current doc tree, I think we can firstly adding new sections like "Get Started", "Develop", and "Deployment", after the new sections are added, we can remove the old sections safely.

what about putting the new document in 5.0 folder or 5.0-dev folder (do not affect the dev folder) ?

5.1 is better, since it's going to be released.

marsishandsome commented 3 years ago

some suggestions:

  1. https://docs.google.com/document/d/1TVrPOk26rmC6Jrhj8MO9vWlOwlTTfq83ZUgfe5WHe4E/edit is only visible to PingCAP employees. It's better to file a Github issue to descript the background, the new doc tree, the plan to complement the new doc tree. Then you can link each related PR to that issue.
  2. All the dev documents in the old content are deleted, which is a big change. After going through the current doc tree, I think we can firstly adding new sections like "Get Started", "Develop", and "Deployment", after the new sections are added, we can remove the old sections safely.

comments are addressed, PTAL

dcalvin commented 3 years ago

ptal @qiancai

marsishandsome commented 3 years ago

@dcalvin PTAL

marsishandsome commented 3 years ago

@dcalvin @andylokandy PTAL

TomShawn commented 3 years ago

@marsishandsome This PR content only applies to v5.1, not to dev?