Repository navigation
Escape variable references in the docs that Asciidoctor reads as attributes #9069 - #9087
Merged
bamaer merged 1 commit intoOct 23, 2026
Merged
Conversation
…ibutes apache#9069 A variable such as ${PROJECT_HOME} in inline code is read by Asciidoctor as the attribute {PROJECT_HOME}, which gives 35 "skipping reference to missing attribute" warnings in 27 pages when building the docs. Write them as `+${PROJECT_HOME}+`, like the other pages already do. Also remove the stray "(TODO)" at the end of the IHopMetadataObjectFactory paragraph in the metadata plugins page of the developer manual.
bamaer
approved these changes
Oct 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Please add a meaningful description for your change here
A variable such as
${PROJECT_HOME}in inline code is read by Asciidoctor as the attribute{PROJECT_HOME}, which produced 35 "skipping reference to missing attribute" warnings in 27 pages. This writes them as+${PROJECT_HOME}+, the form that 299 other places in the docs already use, and removes the stray "(TODO)" at the end of theIHopMetadataObjectFactoryparagraph inmetadata-plugins.adoc.How I checked it: I ran Asciidoctor 2.0.26 with
attribute-missing=warnover all 787 pages before and after. Before there were 35 such warnings in the pages listed in the issue. After there are none, apart frompage-component-version, which is an Antora attribute that Antora supplies at build time and which is not part of this issue. I also rendered a few of the changed pages and checked that the variables still show up literally, for example<code>${PROJECT_HOME}</code>. I did not run the Antora site build ormvn clean install apache-rat:check, since only.adocfiles changed.Addresses #9069
Run
mvn clean install apache-rat:checkto make sure basic checks pass. A more thorough check will be performed on your pull request automatically. (not run, documentation-only change)If you have a group of commits related to the same change, please squash your commits into one and force push your branch using
git rebase -i.Mention the appropriate issue in your description (for example:
addresses #123), if applicable.I hereby declare this contribution to be licensed under the Apache License Version 2.0, January 2004