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

DOC bug fixes - TOCs missing from docs #4723

Merged
merged 3 commits into from
Aug 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/mp/config/advanced-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
13 changes: 6 additions & 7 deletions docs/mp/config/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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]
====
Expand Down
4 changes: 2 additions & 2 deletions docs/se/config/advanced-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/se/config/config-profiles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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>>

Expand All @@ -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`
Expand Down
31 changes: 15 additions & 16 deletions docs/se/config/extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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`):

Expand All @@ -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:

Expand Down Expand Up @@ -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.
Expand Down
15 changes: 8 additions & 7 deletions docs/se/config/hierarchical-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 9 additions & 10 deletions docs/se/config/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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"]
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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]
====
Expand Down
8 changes: 4 additions & 4 deletions docs/se/config/mutability-support.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/se/config/property-mapping.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/se/config/supported-formats.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 14 additions & 4 deletions docs/se/dbclient.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down Expand Up @@ -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
+
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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].
Expand Down
Loading