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

Docs might be in the main repo #88

Closed
maliayas opened this issue Feb 13, 2020 · 1 comment
Closed

Docs might be in the main repo #88

maliayas opened this issue Feb 13, 2020 · 1 comment

Comments

@maliayas
Copy link

IMHO, it is a best practice to put source and docs in the same repo; so that every code change and related docs change go into the same commit.

I see that in order to maintain a connection between source and docs you are using git tags in both repos. Even so, you might consider moving docs to the main repo for better peace of mind.

Moving only en and zh folders (as they are the source for docs) would be enough and this repo (incubator-echarts-doc) would contain the build code for building docs.

Thanks for the great documentation.

@Ovilia
Copy link
Contributor

Ovilia commented Feb 26, 2020

Thanks for your suggestion. We usually update and merge the code ASAP while it usually takes more time to write the document, as long as if it's ready before the next release. We think this makes sure the code is merged ASAP to avoid conflict.

@Ovilia Ovilia closed this as completed Feb 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants