-
Task
-
Resolution: Done
-
Critical
-
None
-
2
-
False
-
-
False
-
-
-
Quarkus Upstream Docs Sprint 9, Quarkus UpstreamDocs Sprint 10
As per recent changes to the upstream doc architecture to reduce the length of the file name.
Summary of change:
@quarkus-docs - Important upstream doc architecture change coming:
In the diataxis restructuring PRs, several community SMEs have repeatedly commented that the AsciiDoc source filenames are way too long. This has come up yet again in the 3.2 security epic doc work. Our adoc file name convention is now changing to remove the content type from the file name and ID. See GitHub issue #33642.
To fix this, Erin has introduced a new attribute in the doc header for setting the content type: diataxis-type placed immediately after the attribute file include. For example:= Enable Basic authentication
include::_attributes.adoc[]
:diataxis-type: howto
:categories: securityThe change to the doc processing build, templates, contributor guide, and some diataxis topics is in progress in PR #33619.