General Doc Bugs 3.0

[ljamen]

Environment Details

• Helidon Version: 3.0
• Helidon SE and Helidon MP
• JDK version:
• OS:
• Docker version (if applicable):

---

SE
Docs that have missing TOCs:

• https://helidon.io/docs/v3/#/se/config/introduction
• https://helidon.io/docs/v3/#/se/config/hierarchical-features
• https://helidon.io/docs/v3/#/se/config/property-mapping
• https://helidon.io/docs/v3/#/se/config/supported-formats
• https://helidon.io/docs/v3/#/se/config/mutability-support
• https://helidon.io/docs/v3/#/se/config/extensions

Docs that have TOC formatting issues:

• https://helidon.io/docs/v3/#/se/webserver

Docs not using new template:

• https://helidon.io/docs/v3/#/se/dbclient
• https://helidon.io/docs/v3/#/se/security/introduction
• https://helidon.io/docs/v3/#/se/aot (websocket)

Lowercase Se

• https://helidon.io/docs/v3/#/se/reactive-messaging

• [ ]
  MP
  Docs that have missing TOCs:

• https://helidon.io/docs/v3/#/mp/config/introduction

• https://helidon.io/docs/v3/#/mp/config/advanced-configuration

Docs that have TOC formatting issues:
<>
https://helidon.io/docs/v3/#/mp/persistence
https://helidon.io/docs/v3/#/mp/persistence needs to be reworked_

Docs not using new template:

• https://helidon.io/docs/v3/#/mp/jaxrs/application-configuration
• https://helidon.io/docs/v3/#/mp/jaxrs/jaxrs-applications
• https://helidon.io/docs/v3/#/mp/security/security
• https://helidon.io/docs/v3/#/mp/security/providers
• https://helidon.io/docs/v3/#/mp/security/configuration-secrets
• https://helidon.io/docs/v3/#/mp/aot

Lowercase Mp

• https://helidon.io/docs/v3/#/mp/lra
• https://helidon.io/docs/v3/#/mp/reactivemessaging/introduction
• https://helidon.io/docs/v3/#/mp/reactivemessaging/kafka
• https://helidon.io/docs/v3/#/mp/reactivemessaging/mock
• https://helidon.io/docs/v3/#/mp/testing
• https://helidon.io/docs/v3/#/mp/testing-ng

From Tim: I think the new/latest approach is that an MP .adoc file has an include::{rootdir}/includes/mp.adodc[] and the obvious parallel for SE.

Formatting issues:

• On this page https://helidon.io/docs/latest/index.html#/mp/security/providers#OIDC-Provider in the CORS Settings section:
  The CORS Settings header looks to be at too high a level (== instead of === I think in docs/includes/security/providers/oidc.adoc). The first sentence there refers to the cors block under the oidc block of the configuration.

• Just below that on that same rendered page is a bad include . It looks as if the problem is at docs/includes/cors.adoc line 93. AsciiDoc requires a file (even for references to tags in the same file according to its documentation) but none is there. Locally as a test I inserted cors.adoc (the current file) just after the :: and my IDE rendered the expected table correctly.
  helidon.iohelidon.io
  Introduction
  Helidon

As of 3.x, Helidon docs have adopted a new doc template:

Overview
Maven Coordinates
Usage
API
Configuration
Examples*
Additional Information*
*use if applicable

[ljamen]

FIXED: mp/config/introduction.adoc says ToC needs to change to Contents https://github.com/oracle/helidon/pull/4477/files

https://helidon.io/docs/v3/#/mp/config/advanced-configuration

[ljamen]

PR #5614 addresses most of these issues. Closing as PR was merged.