codice / ddf

DDF Distributed Data Framework - an open source, modular integration framework.
http://ddf.codice.org
Other
132 stars 181 forks source link

added key words and phrases to docs index #6638

Closed ricklarsen closed 2 years ago

ricklarsen commented 3 years ago

FORWARD PORT of #6625

What does this PR do?

populates the asciidoctor index within the documentation module.

Who is reviewing it?

@shaundmorris @rececoffin @sgalla @jaymcnallie

Select relevant component teams:

@codice/docs

How should this be tested?

builds successfully; has index with links at the very of the pdf documents every document in the target/docs/pdf directory should have its own index with just the topics in that guide. documentation.pdf should have all topics in its index.

Any background context you want to provide?

it's a lot of very small changes. two sets of parens displays the text as the anchor; three parens creates the anchor but hides the text. (I used that when there wasn't a properly capitalized use of a term, or when I wanted an extra anchor for an acronym.

Screenshots

Screen Shot 2021-09-20 at 2 30 50 PM

Checklist:

Notes on Review Process

Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.

Review Comment Legend:

ricklarsen commented 2 years ago

build now

cxddfbot commented 2 years ago

Internal build has been started, your results will be available at build completion.

cxddfbot commented 2 years ago

Build FAILURE See the job results in legacy Jenkins UI or in Blue Ocean UI.

cxddfbot commented 2 years ago

Internal build has been started, your results will be available at build completion.

cxddfbot commented 2 years ago

Build SUCCESS See the job results in legacy Jenkins UI or in Blue Ocean UI.