-
Task
-
Resolution: Done
-
Critical
-
None
-
7
-
False
-
-
False
-
-
-
Quarkus Upstream Docs Sprint 4, Quarkus Upstream Docs Sprint 5
Fix this problem:
Raw upstream AsciiDoc source files imported into the downstream will contain invalid Attributes and Include statements. Attributes will render as, for example "
{maven-version}" and include statements as, for example, "Invalid include: {includes}/devtools/create-app.adoc"
Why?
Because the target Attributes file and Includes files does not exist locally.
Scope of this PR
- Review the imported security files and determine the attribute values that need to be resolved.
- Figure out which attributes are:
- built-in asciidoc ones (like {imagesdir} )
- essential for upstream-first docs.
- identical or duplicate what we already have in downstream.
- Downport the required attributes files to the downstream gitlab repo (attributes.adoc and attributes-local.adoc).
- Review the upstream attributes files and update the relevant values that apply to the security content being downported downstream (note, not all upstream attributes will be relevant.
- Re-architect the attribute implementation if needed so that 2 goals are achieved:
- Minimal or zero changes are needed in the imported upstream-first adoc source file. They work automatically.
- They align with the downstream source docs attribute approach too where possible.
- They work on PV2.
- Test solution on PV2 and ensure all attributes render correctly.
Useful links:
Research done: MR 902
List of invalid links/includes on PV2: Spot check of content imported to PV2 sandbox Google doc
- is cloned by
-
QDOCS-175 Fix anchors that are not rendering in security adoc files downported to downstream repo
- Closed