Skip to content

Refactor geowave-ingest command docs so we can use for manpages as well#184

Merged
chrisbennight merged 1 commit intomasterfrom
GEOWAVE-164-ingest-man-pages
Jan 20, 2015
Merged

Refactor geowave-ingest command docs so we can use for manpages as well#184
chrisbennight merged 1 commit intomasterfrom
GEOWAVE-164-ingest-man-pages

Conversation

@spohnan
Copy link
Copy Markdown
Contributor

@spohnan spohnan commented Jan 15, 2015

This patch does the following:

  • Updates the app site links from a personal branch to the eventual location at ngageoint
    • This commit does not replace our current web site, that will be handled in a future cutover commit once everyone is happy with the state of the docs.
  • Refactors the docs for the geowave-ingest command and creates manpages in addition the current HTML and PDF docs
    • Extracts inline command docs and makes them into manpage docs
    • During the RPM build process these manpages will be tranformed into text and included back into the HTML and PDF documentation

So one update location for geowave-ingest command documentation, the manpages, and the content will get included in all doc formats.

The only caveat with this transformation process is if you create the docs locally by running mvn -P docs -pl docs install there will be holes in your HTML/PDF docs where the info on the commands is included as the extra step of transforming the man pages into text will not get executed (the maven plugin can't transform man pages yet, only HTML and PDF) but during a normal RPM build this will all get handled automatically using the a2x Asciidoc command.

chrisbennight added a commit that referenced this pull request Jan 20, 2015
Refactor geowave-ingest command docs so we can use for manpages as well
@chrisbennight chrisbennight merged commit b991f00 into master Jan 20, 2015
@spohnan spohnan deleted the GEOWAVE-164-ingest-man-pages branch February 2, 2015 14:13
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.

2 participants