On Thu, Mar 15, 2018 at 4:58 AM, Rahul Singh <rahul.xavier.si...@gmail.com> wrote: > > I don’t understand why it’s so complicated. In tree docs are as good as any. > All the old docs are there in the version control system. > > All we need to is a) generate docs for old versions b) improve user > experience on the site by having it clearly laid out what is latest vs. old > docs. and c) have some semblance of a search maybe using something like > Algolia or whatever.
This. Keeping the docs in-tree is a huge win, because they can move in lock-step with changes occurring in that branch/version. I don't think we've been enforcing this, but code-changes that alter documented behavior should be accompanied by corresponding changes to the documentation, or be rejected. Code-changes that correspond with undocumented behavior are an opportunity to include some docs (not grounds to reject a code-review IMO, but certainly an opportunity to politely ask/suggest). Publishing more than one version (as generated from the respective branches/tags), is a solvable problem. > > On Thu, Mar 15, 2018 at 1:22 Kenneth Brotman <kenbrot...@yahoo.com.invalid > > wrote: > > > > > https://issues.apache.org/jira/browse/CASSANDRA-14313 > > > > > > > > > > > > For some reason I'm told by many committers that we should not have sets > > > of > > > documentation for other versions than the current version in a tree for > > > that > > > version. This has made it difficult, maybe impossible to have > > > documentation > > > for all the supported versions on the website at one time. > > > > > > > > > > > > As a solution I propose that we maintain the online documentation in a > > > separate repository that is managed as the current repository under the > > > guidance of the Apache Cassandra PMC (Project Management Committee); and > > > that in the new repository . . . > > > > > > > > > > > > Please see the jira. I hope it's a good answer to everyone. -- Eric Evans john.eric.ev...@gmail.com --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@cassandra.apache.org For additional commands, e-mail: dev-h...@cassandra.apache.org
