DOC bug fixes - TOCs missing from docs (#4723)

helidon-io · Aug 12, 2022 · 2a8ab63 · 2a8ab63
1 parent b898595
commit 2a8ab63
Show file tree

Hide file tree

Showing 12 changed files with 90 additions and 90 deletions.
diff --git a/docs/mp/config/advanced-configuration.adoc b/docs/mp/config/advanced-configuration.adoc
@@ -26,12 +26,12 @@ include::{rootdir}/includes/mp.adoc[]
 
 == Contents
 
-- <<Creating MicroProfile Config Sources for Manual Setup of Config>>
-- <<Creating Custom Config Sources>>
-- <<Creating MicroProfile Config Sources from meta-config>>
-- <<Extending Meta-Config to Create a Custom Config Source Type>>
-- <<Creating MicroProfile Config Source from Helidon SE Config Source>>
-- <<Creating MicroProfile Config Source from Helidon SE Config Instance>>
+- <<Creating MicroProfile Config Sources for Manual Setup of Config, Creating MicroProfile Config Sources for Manual Setup of Config>>
+- <<Creating Custom Config Sources, Creating Custom Config Sources>>
+- <<Creating MicroProfile Config Sources from meta-config, Creating MicroProfile Config Sources from meta-config>>
+- <<Extending Meta-Config to Create a Custom Config Source Type, Extending Meta-Config to Create a Custom Config Source Type>>
+- <<Creating MicroProfile Config Source from Helidon SE Config Source, Creating MicroProfile Config Source from Helidon SE Config Source>>
+- <<Creating MicroProfile Config Source from Helidon SE Config Instance, Creating MicroProfile Config Source from Helidon SE Config Instance>>
 
 == Creating MicroProfile Config Sources for Manual Setup of Config
 

diff --git a/docs/mp/config/introduction.adoc b/docs/mp/config/introduction.adoc
@@ -30,12 +30,11 @@ include::{rootdir}/includes/mp.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Maven Coordinates>>
-- <<Usage>>
-- <<Configuration>>
-- <<Guides>>
-- <<Reference>>
+- <<Overview, Overview>>
+- <<Maven Coordinates, Maven Coordinates>>
+- <<Usage, Usage>>
+- <<Configuration, Configuration>>
+- <<Reference, Reference>>
 
 == Overview
 
@@ -230,7 +229,7 @@ Current properties may be set in `application.yaml` or in `microprofile-config.p
 
 See xref:#Config-Profiles[Config Profiles] for more information.
 
-== Guides
+== Additional Information
 
 [PILLARS]
 ====

diff --git a/docs/se/config/advanced-configuration.adoc b/docs/se/config/advanced-configuration.adoc
@@ -30,7 +30,7 @@ include::{rootdir}/includes/se.adoc[]
 - <<Advanced Config Sources, Advanced Config Sources>>
 - <<Advanced Config Parsers, Advanced Config Parsers>>
 - <<Config Keys with . in name, Config Keys with . in name>>
-- <<filters-and-overrides, Filter Overrides and Token Substitution,>>
+- <<filters-and-overrides, Filters, Overrides and Token Substitution>>
 - <<Executors for Asynchronous Config Activity, Executors for Asynchronous Config Activity>>
 
 == Overview
@@ -532,7 +532,7 @@ that might be in the node's name, in this example in `oracle.com`.
 <6> The config node `"oracle.com"` has type `OBJECT`...
 <7> ...and name `"oracle.com"`.
 
-== Filter, Overrides, and Token Substitution [[filters-and-overrides]]
+== Filters, Overrides, and Token Substitution [[filters-and-overrides]]
 When your application retrieves a config value, the config system can transform it
 before returning the value, according to _filters_, _overrides_, and
 _tokens_. The config system provides some built-in instances of these

diff --git a/docs/se/config/config-profiles.adoc b/docs/se/config/config-profiles.adoc
@@ -27,7 +27,7 @@ include::{rootdir}/includes/se.adoc[]
 == Contents
 
 - <<Overview, Overview>>
-- <<Profile options, Profile options>>
+- <<Profile Options, Profile Options>>
 - <<Profile-Config-Source, Profile Config Source>>
 - <<Profile-File, Profile Files>>
 
@@ -37,7 +37,7 @@ Configuration profiles provide a capability to prepare structure of configuratio
 environment in advance, and then simply switch between these structures using a system property
 or an environment variable.
 
-== Profile options
+== Profile Options
 To choose a configuration profile to use at runtime, you can use:
 
 1. A system property `config.profile`

diff --git a/docs/se/config/extensions.adoc b/docs/se/config/extensions.adoc
@@ -26,16 +26,15 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview,>>
-- <<Introduction>>
-- <<Setting up an extension>>
-- <<Config-SPI-ConfigSource>>
-- <<Config-SPI-ConfigParser>>
-- <<Config-SPI-OverrideSource>>
-- <<Config-SPI-ConfigFilter>>
-- <<Config-SPI-ConfigMapperProvider>>
-- <<Change support SPI>>
-- <<Config-SPI-RetryPolicy>>
+- <<Overview, Overview>>
+- <<Configuring an Extension, Configuring an Extension>>
+- <<Config-SPI-ConfigSource, Config-SPI-ConfigSource>>
+- <<Config-SPI-ConfigParser, Config-SPI-ConfigParser>>
+- <<Config-SPI-OverrideSource, Config-SPI-OverrideSource>>
+- <<Config-SPI-ConfigFilter, Config-SPI-ConfigFilter>>
+- <<Config-SPI-ConfigMapperProvider, Config-SPI-ConfigMapperProvider>>
+- <<Change Support SPI, Change Support SPI>>
+- <<Config-SPI-RetryPolicy, Config-SPI-RetryPolicy>>
 
 == Overview
 
@@ -47,7 +46,7 @@ to Java types, fine-tune the look-up of config data, and reload and
 reprocess data when it changes. _Config extensions_ provided by the application
 modify and expand the way the config system performs these steps.
 
-== Introduction
+
 Each config extension implements one of the interfaces defined in the Configuration SPI:
 
 //Once our asciidoc processing handles labeled lists, uncomment the following
@@ -90,14 +89,14 @@ Service providers:
 
 The config system itself implements several of these SPIs, as noted in the sections below.
 
-== Setting up an extension
+== Configuring an Extension
 
 You can configure a custom extension in two ways:
 
 1. Manual configuration with builder
 2. Automatic configuration using a Java service loader
 
-=== Manual configuration with builder
+=== Manual Configuration with Builder
 
 The following example shows configuration of all possible extensions with `Config` (all custom extension have a name prefix `My`):
 
@@ -115,7 +114,7 @@ Config config = Config.builder()
                 .build()
 ----
 
-=== Automatic configuration using a service loader
+=== Automatic Configuration Using a Service Loader
 
 The following extensions are loaded using a service loader for any configuration instance, and do not require an explicit setup:
 
@@ -369,9 +368,9 @@ module my.module {
 }
 ----
 
-== Change support SPI [[Config-SPI-PollingStrategy]]
+== Change Support SPI [[Config-SPI-PollingStrategy]]
 
-Once it loads a `Config` tree from ``ConfigSource``s the config system does not itself change the in-memory `Config`
+Once it loads a `Config` tree from ``ConfigSource``, the config system does not itself change the in-memory `Config`
  tree. Even so, the underlying data available via the tree's ``ConfigSource``s can change.
 Implementations of link:{config-javadoc-base-url}/io/helidon/config/spi/PollingStrategy.html[`PollingStrategy`]
 may trigger regular check whether a source has new data.

diff --git a/docs/se/config/hierarchical-features.adoc b/docs/se/config/hierarchical-features.adoc
@@ -27,13 +27,14 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Configuration Node Types>>
-- <<Configuration Key>>
-- <<In-memory Representation of Configuration>>
-- <<Access by Key>>
-- <<Access by General Navigation>>
-- <<Detaching a Config Subtree>>
+- <<Overview, Overview>>
+- <<Configuration Node Types, Configuration Node Types>>
+- <<Configuration Key, Configuration Key>>
+- <<In-memory Representation of Configuration, In-memory Representation of Configuration>>
+- <<Access by Key, Access by Key>>
+- <<Access by General Navigation, Access by General Navigation>>
+- <<Detaching a Config Subtree, Detaching a Config Subtree>>
+
 
 == Overview
 

diff --git a/docs/se/config/introduction.adoc b/docs/se/config/introduction.adoc
@@ -27,12 +27,12 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Maven Coordinates>>
-- <<Getting Started>>
-- <<Usage>>
-- <<Guides>>
-- <<Additional Information>>
+- <<Overview, Overview>>
+- <<Maven Coordinates, Maven Coordinates>>
+- <<Usage, Usage>>
+- <<Configuration, Configuration>>
+- <<Reference, Reference>>
+- <<Additional Information, Additional Information>>
 
 == Overview
 
@@ -51,7 +51,7 @@ include::{rootdir}/includes/dependencies.adoc[]
 </dependencies>
 ----
 
-== Getting Started
+== Usage
 A brief overview of the config system helps clarify its different parts and how they work together. Most applications will typically deal with more than one of these parts.
 
 image::config/overview.png["Configuration Overview",align="center"]
@@ -95,9 +95,8 @@ You can extend the system with custom parsers of your own. Implement the link:{c
 
 See the xref:advanced-configuration.adoc#_advanced_config_parsers[advanced topics'] page for further information on some more involved aspects of config parsers.
 
-== Usage
 
-=== Default Configuration
+== Configuration
 
 Helidon has an internal configuration, so you are not required to provide any configuration data for your application, though in practice you most likely would.
 
@@ -305,7 +304,7 @@ to handle other types of sources by implementing the
 link:{config-javadoc-base-url}/io/helidon/config/spi/ConfigSource.html[`ConfigSource`] interface. See
 the xref:extensions.adoc[extensions'] documentation for complete information.
 
-== Guides
+== Reference
 
 [PILLARS]
 ====

diff --git a/docs/se/config/mutability-support.adoc b/docs/se/config/mutability-support.adoc
@@ -26,10 +26,10 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Using Config Metadata>>
-- <<Responding to Changes in Config Sources>>
-- <<Accessing Always-current Values>>
+- <<Overview, Overview>>
+- <<Using Config Metadata, Using Config Metadata>>
+- <<Responding to Changes in Config Sources, Responding to Changes in Config Sources>>
+- <<Accessing Always-current Values, Accessing Always-current Values>>
 
 == Overview
 An in-memory config tree, once loaded, is immutable, even though the data in the underlying

diff --git a/docs/se/config/property-mapping.adoc b/docs/se/config/property-mapping.adoc
@@ -26,11 +26,11 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Converting Configuration to Simple Types>>
-- <<Converting Configuration to Complex Types>>
-- <<Advanced Conversions using Explicit Mapping Logic>>
-- <<Conversions using JavaBean Deserialization>>
+- <<Overview, Overview>>
+- <<Converting Configuration to Simple Types, Converting Configuration to Simple Types>>
+- <<Converting Configuration to Complex Types, Converting Configuration to Complex Types>>
+- <<Advanced Conversions using Explicit Mapping Logic, Advanced Conversions using Explicit Mapping Logic>>
+- <<Conversions using JavaBean Deserialization, Conversions using JavaBean Deserialization>>
 
 == Overview
 

diff --git a/docs/se/config/supported-formats.adoc b/docs/se/config/supported-formats.adoc
@@ -26,9 +26,9 @@ include::{rootdir}/includes/se.adoc[]
 
 == Contents
 
-- <<Overview>>
-- <<Additional Config Formats and Parsers>>
-- <<Additional Config Source Types>>
+- <<Overview, Overview>>
+- <<Additional Config Formats and Parsers, Additional Config Formats and Parsers>>
+- <<Additional Config Source Types, Additional Config Source Types>>
 
 == Overview
 Helidon Config provides several extension modules that support other configuration

diff --git a/docs/se/dbclient.adoc b/docs/se/dbclient.adoc
@@ -24,6 +24,16 @@
 
 include::{rootdir}/includes/se.adoc[]
 
+== Contents
+
+-  <<Overview, Overview>>
+-  <<Maven Coordinates, Maven Coordinates>>
+-  <<Usage, Usage>>
+-  <<API, API>>
+-  <<Configuration, Configuration>>
+-  <<Additional Information, Additional Information>>
+
+== Overview
 The Helidon SE DB Client provides a unified, reactive API for working with databases in non-blocking way.
 
 include::{rootdir}/includes/dependencies.adoc[]
@@ -54,12 +64,12 @@ Or to use with MongoDB client add the following dependency:
 </dependency>
 ----
 
-== Helidon DB Client Features Overview
+== Usage
 
 The DB Client simplifies how you work with databases by abstracting the type of the database.
 The API can be used both for relational and non-relational databases.
 
-The API provides:
+== API
 
 * Database configuration abstraction
 +
@@ -89,7 +99,7 @@ for backpressure (result set is processed as requested by the query subscriber)
 The API offers support for health checks, metrics and tracing.
 
 
-== Getting Started
+== Configuration
 
 Before you begin you must add the DB Client dependencies and configure the client.
 
@@ -292,7 +302,7 @@ Execution of a query statement will always return `Multi<DbRow>>`. `Multi` has s
 * `Single<List<DbRow>> collectList()` to collect all rows and return them as a promise of `List<DbRow>`
 * `<U> Multi<U> map(…)` to map returned result using provided mapper
 
-== Next Steps
+== Additional Information
 
 Now that you understand how to build and execute statements, try it for yourself.
 link:{helidon-github-tree-url}/examples/dbclient[DB Client Examples].