Hi:

I think it might be better to separate.


The current document is following the version, you can refer to this[1]


We will update synchronously every time we release. When new features are 
submitted, contributors also need to submit documents after merging the code.


I suggest keeping the documentation and the code separate so that it is more 
clear. For me, if there is a document, I will go to the official website to 
view the document online, just open the browser, instead of opening the code 
repository, and then look for it, Corresponding documents. That is too 
inefficient for me.
Similarly, we can also ensure that the source code package or binary package 
will not be too large when releasing, which is more convenient for users to 
download.


The related PR changes can be described similarly to SkyWalking by adding 
change.md[1], so that during the release, the documents can be checked for 
omissions, and users can quickly check the version changes after downloading.


[1]https://dolphinscheduler.apache.org/en-us/docs/
[2]https://github.com/apache/skywalking/blob/5.x/CHANGES.md


Best Wishes!
CalvinKirs, Apache DolphinScheduler PMC


On 09/6/2021 14:37,Jiajie Zhong<[email protected]> wrote:
Hi guys,
I found out we separate our code repo and docs repo into two different repo:
https://github.com/apache/dolphinscheduler-website 
<https://github.com/apache/dolphinscheduler-website> and 
https://github.com/apache/dolphinscheduler 
<https://github.com/apache/dolphinscheduler>.

I don’t know the original reason, but IMO we should combine the docs and 
codebase into same repo.
It is have several advantageous as below:
* when we change our behavior, we could modify related doc to keep our doc up 
to date
* when we release our code we could also release our doc, (docs follow our 
code), could make our doc versionable
* when adding a tag for specific commit, docs would include with it(base on 
first point)

So, I proposal we could combine docs into codebase repo

And here are some of other Apache repo which codebase including docs
* Apache Spark: https://github.com/apache/spark/tree/master/docs 
<https://github.com/apache/spark>
* Apache Flink: https://github.com/apache/flink/tree/master/docs/content/docs 
<https://github.com/apache/flink/tree/master/docs/content/docs>

BTW, we could still keep https://github.com/apache/dolphinscheduler-website 
<https://github.com/apache/dolphinscheduler-website> repo and make it just an 
site
for our leading page


Best Wish
— Jiajie



Reply via email to