Re: committing doc changes

2017-05-11 Thread Michael Han
I suspect removing of the compiled doc from git source repo will not break https://zookeeper.apache.org/ because we publish the web site through CMS from the site's svn repo , which is a separate repo. So I am +1 with this

Re: committing doc changes

2017-04-28 Thread Abraham Fine
Apologies for reviving an old thread. I'm wondering if we can make this conversation actionable. It would be great to remove the compiled documentation from the repository. I created a JIRA to cover this work: https://issues.apache.org/jira/browse/ZOOKEEPER-2769 Does anyone have any insight into

Re: committing doc changes

2016-12-05 Thread Patrick Hunt
As Flavio mentioned we (committers) commit the docs so that users interested in d/l the source and using it don't need to generate the docs, which requires forrest and could often be a pita. In the early days this was seen as a benefit. That's the history at least. Patrick On Thu, Dec 1, 2016 at

Re: committing doc changes

2016-12-01 Thread Michael Han
Run forrest check only take a few seconds, so it seems worthwhile to add it to QA target to have some sanity checks on the doc change. On Thu, Dec 1, 2016 at 3:20 AM, Flavio Junqueira wrote: > We currently do it for the trunk build: > > > > but not for pull request or patch

Re: committing doc changes

2016-12-01 Thread Flavio Junqueira
We currently do it for the trunk build: but not for pull request or patch QA: "forrest.check" only checks if the forrest.home variable is defined. Is that enough that we run it as part of the trunk build? -Flavio > On 01 Dec 2016, at 01:04, Benjamin Reed wrote: > > we

Re: committing doc changes

2016-11-30 Thread Benjamin Reed
we could also build the doc as part of the tests. On Wed, Nov 30, 2016 at 3:26 PM, Flavio Junqueira wrote: > As part of the release process, we only copy the documentation, see it here: > > https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease >

Re: committing doc changes

2016-11-30 Thread Flavio Junqueira
As part of the release process, we only copy the documentation, see it here: https://cwiki.apache.org/confluence/display/ZOOKEEPER/HowToRelease I think the reason we have gone this way is to avoid issues compiling the

Re: committing doc changes

2016-11-30 Thread Benjamin Reed
yeah, that's a deeper question. pat or flavio can correct me on this, but i think the reason we check it in is so that the website's "trunk" documentation will work. now that we moved to git, i don't thing it works though... i also would just like to only build it when we do releases. On Wed, Nov

Re: committing doc changes

2016-11-30 Thread Michael Han
+1 on the idea of separating doc source change with doc binary change. Actually, should we just remove the binary doc from source repository given they are artifacts that's only relevant to a release build (instead of source)? On Wed, Nov 30, 2016 at 2:24 PM, Jordan Zimmerman <

Re: committing doc changes

2016-11-30 Thread Jordan Zimmerman
I wondered about that myself. Why bother building the docs? Isn’t that only needed for packaging/deployment? It ends up making PRs ugly because you have all the unnecessary docs in the diff. -Jordan > On Nov 30, 2016, at 11:23 PM, Benjamin Reed wrote: > > when we commit