Incorporating Jamal macro into the documentation #1229
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.
Documentation maintenance enhancement adding Jamal to the documentation toolset
Description
Goal
Adding this change to the build process, the documentation will automatically fetch and use the latest release.
Later the tool use can be gradually extended to reduce documentation and code redundancy, automatically pulling information from the documented source code into the documentation.
The pull request
README.adoc.jam
file intoREADME.adoc
.README.adoc
toREADME.adoc.jam
and extended it with macros to fetch the versions automatically when the documentation is processed while editing in IntelliJ/AsciidocFX or during the build.An alternative way could be to write some specific test that updates the documentation, but Jamal does it, and it is a powerful framework for the very purpose. I do not know any professional alternative. It is also possible to keep editing the pure Asciidoc without macros and invest the manual effort to keep the version numbers and other features in the documentation up to date, which was unsuccessful.
Adding this pull request will require document editors to know a bit of Jamal, which complicates the markup being a hyper markup above the Asciidoc markup.
Release notes
Documentation processing is extended using Jamal.