Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Documentation Inventory (In progress)

Documentation ArtifactSourcePublishedPurposeAudienceProcessNotes
Confluence: CASSANDRAhttps://cwiki.apache.org/confluence/display/CASSANDRA/HomeSameMain wiki for the Apache Cassandra Project
Confluence edits.Fairly easy to contribute.
Confluence: CASSANDRA2https://cwiki.apache.org/confluence/display/CASSANDRA2/HomeSameImported wiki for the Apache Cassandra Project
Imported from old wiki?Need to clean this as we fill out primary WIKI
Src.Doc: Websitehttps://svn.apache.org/repos/asf/cassandra/site/src/https://cassandra.apache.org/Apache Cassandra main website (dependent on nodetool binary)

Built using Jekyll. 

Must build cassandra first. 

Have to break the dependency on nodetool documentation. 

Too difficult to quickly help with the website. Unnecessary friction.

Src.Doc: Documentationhttps://github.com/apache/cassandra/tree/trunk/dochttps://cassandra.apache.org/doc/Apache Cassandra documentation (dependent on nodetool binary)

Build using Sphinx

Must build cassandra first. 

Have to break the dependency on nodetool documentation. 

Too difficult to quickly help with the website. Unnecessary friction.

Src.Doc: Nodetoolhttps://github.com/apache/cassandra/blob/trunk/doc/gen-nodetool-docs.pyhttps://cassandra.apache.org/doc/latest/tools/nodetool/Nodetool documentation (generated by nodetool binary)

Build using Nodetool output.

Then using python tool. 

Must build cassandra first.