search

ctargett / refguide-asciidoc-poc

Proof of concept of Solr Ref Guide converted to asciidoc format & using Asciidoctor for publishing
2 stars 4 forks source link

need "macro" for javadoc links #26

Closed hossman closed 7 years ago

hossman commented 7 years ago

we'll need to setup some sort of macro similar to what confluence used for javadoc URLs so we can always point to the correct ones.

At a miminum, using variables from issue #25 in otherwise absolute URLs -- but ideally we should use relative URLs when people are building locally (or, for example, if a jenkins build is building solr + ref-guide all at once ... depends on how things get integrated)

ctargett commented 7 years ago

We should consider Asciidoctor's attribute substitution feature. It's a bit of a core concept, and poorly documented, but essentially, somewhere we have a rule that says :javadoc: https://path/to/javadocs. Then wherever we want a javadoc link, we write it as {javadoc}/solrClass.

The only question would be where we put the attribute definition. At the worst, it's in _config.yml, but maybe it can be somewhere more central to Lucene/Solr builds.