SQUASH ME: ninja-fix (dependency is in build.xml not Makefile)#18
Open
michaelsembwever wants to merge 5 commits intopolandll:trunkfrom
Open
SQUASH ME: ninja-fix (dependency is in build.xml not Makefile)#18michaelsembwever wants to merge 5 commits intopolandll:trunkfrom
michaelsembwever wants to merge 5 commits intopolandll:trunkfrom
Conversation
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
- <*.spec files>
Patch by Lorina Poland; reviewed by Michael Semb Wever and Anthony Grasso for CASSANDRA-16763
* Fixed AsciiDoc link errors
* Deleted Docker files which ran Sphinx
* Deleted Make files
* Deleted Python scripts which generated RST files as they have been replaced with scripts in the 'scripts' directory that generate ADOC files
* Removed configuration documentation file
- doc/modules/cassandra/pages/configuration/cass_yaml_file.adoc
* Removed all 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 <lorina@datastax.com>
* 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
…ate README.md too.
michaelsembwever
force-pushed
the
mck/16763/trunk
branch
from
a2315e9 to
641555b
Compare
polandll
force-pushed
the
trunk
branch
3 times, most recently
from
1020f5a to
7204bc4
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.