diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index 9dbb2c5..9269a9f 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -9,21 +9,17 @@ How-to guides Manage the full operations lifecycle of the ``cloudflared`` charms, from initial deployment through production maintenance. -DNS and networking ------------------- - -.. toctree:: - :maxdepth: 1 - - Configure DNS - Expose a front-end application - Charm operations ---------------- +Understanding operational tasks, such as configuration and backup, +is essential to use the Cloudflared charms. + .. toctree:: :maxdepth: 1 + Configure DNS + Expose a front-end application Use the configurator charm Integrate with COS Back up and restore @@ -34,6 +30,9 @@ Charm operations Development and community ------------------------- +Discover how to resolve common deployment issues and contribute +any bug fixes or features to the Cloudflared charms. + .. toctree:: :maxdepth: 1 diff --git a/docs/reference/cryptographic-overview.rst b/docs/reference/cryptographic-overview.rst index ae14074..6709332 100644 --- a/docs/reference/cryptographic-overview.rst +++ b/docs/reference/cryptographic-overview.rst @@ -1,10 +1,10 @@ .. meta:: - :description: An overview of the cryptographic components used by the Cloudflared charms. + :description: An overview of the security and cryptographic components used by the Cloudflared charms. .. _reference_cryptographic_overview: -Cryptographic overview -====================== +Security and cryptographic overview +=================================== The charms do not implement cryptographic protocols. Juju protects the tunnel credential as a `secret `_, diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 9885155..9e1bc3a 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,15 +6,15 @@ Reference ========= -This section contains technical details about the ``cloudflared`` subordinate -machine charm and the ``cloudflare-configurator`` charm. It documents their -configuration, actions, events, relations, and operational interfaces. +Technical specifications and architectural details about the `cloudflared` +subordinate charm and the `cloudflare-configurator` charm. Charm usage ----------- -The following pages provide reference information for deploying and integrating -the charms. +Operators control charm behavior through configuration options, Juju actions, +and Juju integrations. Learn the inner workings of the charm, which can help +you understand the current charm configuration interface and debug problems. .. vale Canonical.013-Spell-out-numbers-below-10 = NO .. vale Canonical.500-Repeated-words = NO @@ -35,8 +35,8 @@ the charms. Architecture and deployments ---------------------------- -These pages describe the subordinate workload, the configurator, and their -relations to a principal application. +Peek into the design and architecture of the charm, which is useful if you want to +audit or contribute to the Cloudflared charm project. .. toctree:: :hidden: @@ -44,14 +44,4 @@ relations to a principal application. Charm architecture High-level deployment overview - -Advanced topics ---------------- - -These pages cover cryptographic boundaries. - -.. toctree:: - :hidden: - :maxdepth: 1 - - Cryptographic overview + Security and cryptographic overview