Add preview to PRs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Change Request
This repository is ONLY used to solve problems related to DOCS-CN.
For other issues (TiDB, TiKV, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
- Describe what you find is inappropriate or missing in the existing docs.
There are PingCAP Markdown specific syntaxes, like copy-sql and ebnf grammar. Currently we don't know how they will be rendered.
- Describe your suggestion or addition.
We can add a CI to deploy doc previews to somewhere like Netlify, so that people can preview the PR.
- Provide some reference materials (documents, websites, etc) if you could.
There are already previews in the website-docs: https://github.com/pingcap/website-docs/pull/234
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the rendering behavior of the copy-sql and ebnf syntaxes, then compare the preview approach in website-docs PR #234. Define a CI deployment target such as Netlify and verify that pull request previews render these syntaxes before considering the issue done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100