diff options
author | Ronny Berndt <ronny@apache.org> | 2023-02-20 18:00:21 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-20 18:00:21 +0100 |
commit | c866b488d2085a0b0d16a67e20919e03a27e7ef0 (patch) | |
tree | a71444815a4aa5353f49c0dd7d97eaa49da1a07a | |
parent | b38885114414518c327bc411b46bdbf45c15a6d9 (diff) | |
download | couchdb-c866b488d2085a0b0d16a67e20919e03a27e7ef0.tar.gz |
Unifying the notation of dynamic parameters in the docs (#4436)
The pattern `{var}` has been established to clarify dynamic
parameters in the documentation. Standardization and clarification
of some not yet converted notation of parameters.
-rw-r--r-- | src/docs/src/config/auth.rst | 2 | ||||
-rw-r--r-- | src/docs/src/config/compaction.rst | 2 | ||||
-rw-r--r-- | src/docs/src/maintenance/compaction.rst | 2 | ||||
-rw-r--r-- | src/docs/src/whatsnew/2.3.rst | 4 | ||||
-rw-r--r-- | src/docs/src/whatsnew/3.2.rst | 2 | ||||
-rw-r--r-- | src/docs/src/whatsnew/3.3.rst | 6 | ||||
-rw-r--r-- | src/smoosh/operator_guide.md | 4 |
7 files changed, 11 insertions, 11 deletions
diff --git a/src/docs/src/config/auth.rst b/src/docs/src/config/auth.rst index 87f181afe..984fa05d5 100644 --- a/src/docs/src/config/auth.rst +++ b/src/docs/src/config/auth.rst @@ -217,7 +217,7 @@ Authentication Configuration To retrieve a complete list of supported hash algorithms you can use our ``bin/remsh`` script and retrieve a full list of available hash algorithms with ``crypto:supports(hashs).`` or use the - :ref:`_node/$node/_versions <api/server/versions>` endpoint to retrieve the + :ref:`_node/{node-name}/_versions <api/server/versions>` endpoint to retrieve the hashes. .. warning:: diff --git a/src/docs/src/config/compaction.rst b/src/docs/src/config/compaction.rst index 620c2b922..78e18f52f 100644 --- a/src/docs/src/config/compaction.rst +++ b/src/docs/src/config/compaction.rst @@ -99,7 +99,7 @@ following parameters. observe the system and make a smarter decision about what to compact first. Hardly ever changed from the default of 30 (seconds). -.. config:section:: smoosh.<channel> :: Per-channel configuration +.. config:section:: smoosh.{channel-name} :: Per-channel configuration The following settings control the resource allocation for a given compaction channel. diff --git a/src/docs/src/maintenance/compaction.rst b/src/docs/src/maintenance/compaction.rst index 5f3ff02cc..6f8b44349 100644 --- a/src/docs/src/maintenance/compaction.rst +++ b/src/docs/src/maintenance/compaction.rst @@ -84,7 +84,7 @@ and another one for views. Channel Configuration --------------------- -Channels are defined using ``[smoosh.<channel_name>]`` configuration blocks, and +Channels are defined using ``[smoosh.{channel-name}]`` configuration blocks, and activated by naming the channel in the ``db_channels`` or ``view_channels`` configuration setting in the ``[smoosh]`` block. The default configuration is diff --git a/src/docs/src/whatsnew/2.3.rst b/src/docs/src/whatsnew/2.3.rst index 7e2b2d01c..42a62e523 100644 --- a/src/docs/src/whatsnew/2.3.rst +++ b/src/docs/src/whatsnew/2.3.rst @@ -99,8 +99,8 @@ Upgrade Notes a reverse proxy server in front of CouchDB (such as haproxy) to proxy access to other services or domains alongside CouchDB. * :ghissue:`1543`: The node-local (default port 5986) ``/_restart`` endpoint has been - replaced by the clustered (default port 5984) endpoint ``/_node/$node/_restart`` and - ``/_node/_local/_restart`` endpoints. The node-local endpoint has been removed. + replaced by the clustered (default port 5984) endpoint ``/_node/{node-name}/_restart`` + and ``/_node/_local/_restart`` endpoints. The node-local endpoint has been removed. * :ghissue:`1764`: All python scripts shipped with CouchDB, including ``couchup`` and the ``dev/run`` development cluster script, now specify and require Python 3.x. * :ghissue:`1396`: CouchDB is now compatible with Erlang 21.x. diff --git a/src/docs/src/whatsnew/3.2.rst b/src/docs/src/whatsnew/3.2.rst index d9962c5e1..76b901bf3 100644 --- a/src/docs/src/whatsnew/3.2.rst +++ b/src/docs/src/whatsnew/3.2.rst @@ -57,7 +57,7 @@ Features and Enhancements sequences. * :ghissue:`3798`: ICU driver and collator algorithm versions are - returned in the ``_node/$node/_versions`` result. + returned in the ``_node/{node-name}/_versions`` result. * :ghissue:`3801`: Users with the ``_metrics`` role can now read ``_prometheus`` metrics. diff --git a/src/docs/src/whatsnew/3.3.rst b/src/docs/src/whatsnew/3.3.rst index 3b205aeec..1ce953ede 100644 --- a/src/docs/src/whatsnew/3.3.rst +++ b/src/docs/src/whatsnew/3.3.rst @@ -64,7 +64,7 @@ Features and Enhancements test coverage to 90%. * :ghissue:`3798`: Add ``libicu`` version and collation algorithm version to - ``/_node/_local/_versions``. + ``/_node/{node-name}/_versions``. * :ghissue:`3837`: The Erlang source tree is now auto-formatted with ``erlfmt``. @@ -134,7 +134,7 @@ Features and Enhancements -> sha256). This introduces a new config setting ``hash_algorithms``. New cookie values are hashed with sha256, sha1 hashes are still accepted. Admins can set this to sha256 only. Sha1 will be disallowed in the next major release. Show - supported hash algorithms in ``/_node/_local/_versions`` endpoint. + supported hash algorithms in ``/_node/{node-name}/_versions`` endpoint. * :ghissue:`4179`: Don't double-encode changes sequence strings in the replicator. @@ -408,7 +408,7 @@ Docs * :ghissue:`4307`, :ghissue:`4174`: Update Sphinx to version 5.3.0 -* :ghissue:`4170`: Document the ``/_node/_local/_versions`` endpoint. +* :ghissue:`4170`: Document the ``/_node/{node-name}/_versions`` endpoint. Builds ------ diff --git a/src/smoosh/operator_guide.md b/src/smoosh/operator_guide.md index 4764333bd..3edfd3b1d 100644 --- a/src/smoosh/operator_guide.md +++ b/src/smoosh/operator_guide.md @@ -115,14 +115,14 @@ file are no longer live; this includes old btree nodes and document bodies. Compaction takes this file and writes a new file that only contains live data. `total_data` is the number of bytes in the file as reported by `ls -al -filename`. In `db_info` reponse this is the `sizes.file` value. +filename`. In `db_info` response this is the `sizes.file` value. ### Defining a channel Defining a channel is done via normal dbcore configuration, with some convention as to the parameter names. -Channel configuration is defined using `smoosh.$channel_name` top level config +Channel configuration is defined using `smoosh.{channel-name}` top level config options. Defining a channel is just setting the various options you want for the channel, then bringing it into smoosh's sets of active channels by adding it to either `db_channels` or `view_channels`. |