chore: prevent asciidoctor warnings when building documentation #1629
Conversation
oemebamo
had a problem deploying
to
documentation (preview)
GitHub Actions
Failure
|
oemebamo
had a problem deploying
to
documentation (preview)
GitHub Actions
Failure
|
Hello @oemebamo! Thanks for the contribution, but I'm afraid it doesn't work. I had a suspicion already, but was only able to confirm when the docs CI started working. See how the docs are supposed to look: 
And how they actually look in your PR: 
The escaping makes the placeholder not be recognized. |
|
Aha, thanks. So some of them are actual placeholders. Any idea where this warning would then come from? I'm assuming this adoc is included in documents where the placeholder is undefined? |
|
My current theory is that the placeholders are correct placeholders, but their values are missing for some reason. IMO they're supposed to come from this file: This is auto-generated and only present on released tags. |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes Asciidoctor build warnings by escaping attribute references and properly terminating listing blocks in the documentation.
- Escape
{...}attribute references across several quickstart and integration docs - Add missing
----terminator for an unterminated listing block - Update Gradle snippets and import examples to prevent missing-attribute warnings
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/quickstart/shared/solutionsourcecode.adoc | Escaped {quickstarts-clone-url} and {quickstarts-archive-url} references |
| docs/src/modules/ROOT/pages/quickstart/shared/java-logback-config.adoc | Added missing ---- to close a listing block |
| docs/src/modules/ROOT/pages/quickstart/shared/constrainttests.adoc | Escaped {wiringannotationfq}, {testannotationfq}, and inline annotations |
| docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc | Escaped ${timefoldSolverVersion} and ${logbackVersion} in Gradle snippets |
| docs/src/modules/ROOT/pages/integration/config-properties.adoc | Escaped {property_prefix} and {solver_name_prefix} everywhere |
| @@ -903,13 +903,11 @@ Java:: | |||
| + | |||
| -- | |||
| include::../shared/java-logback-config.adoc[] | |||
| ---- | |||
There was a problem hiding this comment.
I'd like to keep this change.
| -- | ||
| Kotlin:: | ||
| + | ||
| -- | ||
| include::../shared/java-logback-config.adoc[] | ||
| ---- |
| </configuration> | ||
| ---- |
When building the docs for this repository, asciidoctor gives a couple of warnings. This PR fixes those warnings.
Most of them are forgotten escaping for
{variables}and then a couple of places where blocks weren't ended properly.Before:
After:
🪄