> The website should be the easiest thing for people to work on. Most of the > documentation should be easy as well. Not all documentation has a 1-1 > correlation to code. > > The Website and Documentation are sibling artifacts in my opinion, but the > website shouldn't have a hard dependency on the core binaries.
Thanks for raising the issue Rahul. The website generation process certainly needs some work. Note, that the correlation is not 1-1. Today the website can generate and link to different versions of the code documentation. For example: - https://cassandra.apache.org/doc/latest/ - https://cassandra.apache.org/doc/4.0/ - https://cassandra.apache.org/doc/3.11.3 - https://cassandra.apache.org/doc/3.11 A patch to better expose and link to these is in CASSANDRA-14954. It is waiting on a reviewer. But, by the same notion, there's nothing preventing there being a 1-0 relationship when regenerating the website docs. Some of the headache will the website generation was listed by Michael here: https://issues.apache.org/jira/browse/CASSANDRA-13907?focusedCommentId=16211161&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-16211161 Generation via docker-compose was meant as an incremental improvement on these headaches, done in CASSANDRA-14972 Being but an incremental step we were hoping it would continue to get improved. For example the html patch generated for even small website updates is massive and trashes the svn history (as Michael also pointed out). regards, Mick --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@cassandra.apache.org For additional commands, e-mail: dev-h...@cassandra.apache.org
