SQUASH ME - make ant gen-doc work again (in a preliminary way). update README.md too
#19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit sets up a new documentation structure and format:
* The directory struture changes from a Sphinx project to an Antora module layout.
* The formatting of the content changes from reStructuredText to AsciiDoc.
The documentation must now be built and published with Antora.
This change was done to make maintaining versioning documentation easier. As
Antora is designed to generate versioned documentation.
The old directory structure was:
<ROOT>
- doc/
- cql3/
- CQL.css
- CQL.textile
- source/
- _static/
- _templates/
- _theme/
- _util/
- <other directory sections>/
- conf.py
- index.rst
- <other *.rst pages>
- make.bat
- Makefile
- README.md
- SASI.md
- <*.spec files>
- <generation scripts>
The new directory structure organises the documentation into modules:
<ROOT>
- doc/
- cql3
- modules/
- cassandra/
- assets/
- examples/
- pages/
- partials/
- nav.adoc
- ROOT/
- pages/
- nav.adoc
- scripts/
- antora.yaml
- README.md
- SASI.md
Patch by Lorina Poland; reviewed by Michael Semb Wever and Anthony Grasso for CASSANDRA-16763
* Changed document file location
* Added BNF content
* Moved *.spec files back to their original location
* Removed Makefile and legacy documentation tooling
* Removed generate Cassandra configuration documentation file
- doc/modules/cassandra/pages/configuration/cass_yaml_file.adoc
* Removed all generated nodetool command (.txt) and documentation (*.adoc) files
- doc/modules/cassandra/examples/TEXT/NODETOOL/*.txt
- doc/modules/cassandra/pages/tools/nodetool/*.adoc
- doc/modules/cassandra/pages/tools/nodetool/nodetool.txt
* Removed legacy .rst -> .adoc conversion script
- doc/modules/cassandra/pages/tools/nodetool/convert.sh
Patch by Anthony Grasso; reviewed by Michael Semb Wever for CASSANDRA-16763
Co-authored-by: polandll <[email protected]>
* Added documentation files to RAT exclude list:
- doc/antora.yaml
- doc/modules/*
* Added generated doc files to .gitignore:
- doc/modules/cassandra/pages/configuration/cass_yaml_file.adoc
- doc/modules/cassandra/pages/tools/nodetool/
- doc/modules/cassandra/examples/TEXT/NODETOOL/
Patch by Anthony Grasso; reviewed by Michael Semb Wever for CASSANDRA-16763
michaelsembwever
force-pushed
the
mck/16763/cassandra-3.11
branch
from
c665e88
to
67f4315
Compare
…ate README.md too. doc/cql3/CQL.css needs to be restored too (used in debian packaging)
michaelsembwever
force-pushed
the
mck/16763/cassandra-3.11
branch
from
67f4315
to
2f19d4d
Compare
polandll
force-pushed
the
cassandra-3.11
branch
from
473806e
to
fc3ad65
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ossarga