Skip to content

Documentation and man page reorganization#246

Merged
rfecher merged 3 commits intomasterfrom
GEOWAVE-147-Docs-to-AsciiDoc
Mar 4, 2015
Merged

Documentation and man page reorganization#246
rfecher merged 3 commits intomasterfrom
GEOWAVE-147-Docs-to-AsciiDoc

Conversation

@spohnan
Copy link
Copy Markdown
Contributor

@spohnan spohnan commented Feb 20, 2015

This commit reorganizes the documentation files to get around an earlier issue with the asciidoc maven plugin not generating man pages and contains the configuration to replace the current https://ngageoint.github.io/geowave/ site. The two new content pages, PDAL and GSOC 2015 have also been migrated into the new format.

EPUB3 support has been added with a new (alpha) library. The epub output looks pretty bad at the moment but we can follow along and at the point it's decent we could start distributing in that format. Man pages are still generated but only by the backend Jenkins worker that has the native asciidoc package installed.

For ease of inspection I've pushed the site generated from this commit to my fork and can be viewed at http://spohnan.github.io/geowave/

To generate the documentation locally check out this branch and run the command mvn -P docs -pl docs install and look under the target/site directory. I ended up using a black on white stylesheet as it seemed more readable but docs/pom.xml line 196 can be changed to <stylesheet>slate.css</stylesheet> or a new stylesheet could be created if the dark theme is desired.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage remained the same at 34.86% when pulling 43f445f on GEOWAVE-147-Docs-to-AsciiDoc into 7bdc096 on master.

@coveralls
Copy link
Copy Markdown

Coverage Status

Coverage decreased (-5.7%) to 29.15% when pulling 9e572fa on GEOWAVE-147-Docs-to-AsciiDoc into fb59922 on master.

rfecher added a commit that referenced this pull request Mar 4, 2015
Documentation and man page reorganization
@rfecher rfecher merged commit a0f4aab into master Mar 4, 2015
@rfecher rfecher deleted the GEOWAVE-147-Docs-to-AsciiDoc branch March 4, 2015 13:47
@spohnan spohnan mentioned this pull request Mar 16, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants