Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Declare h1-prefix as early as possible so it is used for the title prefix #5667

Merged
merged 1 commit into from
Dec 15, 2022

Conversation

tjquinno
Copy link
Member

@tjquinno tjquinno commented Dec 13, 2022

Fixes #5665

Even though includes/mp.adoc declares h1-prefix as MP, and mp/metrics/metrics-capable-components.adoc includes mp.adoc[], the only way I found to get the prefix on the rendered page to work was to declare h1-prefix really early in the mp/metrics/metrics-capable-components.adoc file.

@tjquinno tjquinno added this to the 3.0.3 milestone Dec 13, 2022
@tjquinno tjquinno self-assigned this Dec 13, 2022
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Dec 13, 2022
@@ -17,6 +17,7 @@
///////////////////////////////////////////////////////////////////////////////

= Metrics-Capable Modules
:h1-prefix: MP
:description: Helidon MP metrics-capable modules
:keywords: helidon, metrics, metrics-capable, microprofile, guide
:intro-project-name: {h1-prefix}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about moving :intro-project-name: {h1-prefix} after the include of mp.adoc ; does that work ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another way, which I think is better, is to use conditionals in the common content directly.

This makes the common docs "polymorphic" (big word :D) ; and sort of standalone (as it depends on the flavor include).

It does simplify the "contract" of these kind of common documents.
It can also help the GitHub rendering and set default values for the cases where the required attributes are not set.

@tjquinno tjquinno merged commit 9881679 into helidon-io:helidon-3.x Dec 15, 2022
@tjquinno tjquinno deleted the metrics-doc-typo-3.x branch December 15, 2022 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typo (SE instead of MP) in MP -> Metrics -> Metrics-Capable Modules page header at top of page
3 participants