This is an automated email from the ASF dual-hosted git repository. cmcfarlen pushed a commit to branch 10.0.x in repository https://gitbox.apache.org/repos/asf/trafficserver.git
commit bc714cb9d688c485141f52235f055a6893d9bc74 Author: Damian Meden <[email protected]> AuthorDate: Thu Feb 22 09:31:58 2024 +0100 Docs: Fix few things related to the docs. (#11087) - Fix missing link for TxnBox inside the plugins main doc page. - Fix doctree for Stale response plugin. (cherry picked from commit dbc71ed8496f495ddfb1198b4cc0054908689ffa) --- doc/admin-guide/plugins/index.en.rst | 3 +++ doc/admin-guide/plugins/stale_response.en.rst | 10 +++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/admin-guide/plugins/index.en.rst b/doc/admin-guide/plugins/index.en.rst index dde76a1cf4..5e33fcf722 100644 --- a/doc/admin-guide/plugins/index.en.rst +++ b/doc/admin-guide/plugins/index.en.rst @@ -278,3 +278,6 @@ directory of the |TS| source tree. Experimental plugins can be compiled by passi :doc:`Wasm <wasm.en>` Allows WebAssembly/Wasm (proxy-wasm) module to be used as ATS Plugin. + +:doc:`Transaction Box(TxnBox) <txn_box/index.en>` + Transaction Box, or TxnBox, is an Apache Traffic Server plugin to manipulate transactions. diff --git a/doc/admin-guide/plugins/stale_response.en.rst b/doc/admin-guide/plugins/stale_response.en.rst index 3e60753304..2d3102d8d4 100644 --- a/doc/admin-guide/plugins/stale_response.en.rst +++ b/doc/admin-guide/plugins/stale_response.en.rst @@ -36,7 +36,7 @@ responses. For more details, see `RFC 5861 directives. Building and Installation -************************* +========================= The Stale Response plugin is an experimental plugin. To build it, pass ``-DBUILD_EXPERIMENTAL_PLUGINS=ON`` to the ``cmake`` command when building |TS|. @@ -44,7 +44,7 @@ By default, that will build the ``stale_response.so`` plugin and install it in the ``libexec/trafficserver`` directory. Configuration -************* +============= The Stale Response plugin supports being used as either a global plugin or as a remap plugin. To configure |TS| to use the Stale Response plugin, simply add it @@ -77,7 +77,7 @@ The plugin by default will only perform one asynchronous request at a time for a given URL. This can be changed with the ``--force-parallel-async`` option. Logging -******* +======= The plugin can log information about its behavior with respect to the ``stale-while-revalidate`` and ``stale-if-error`` directives. @@ -93,7 +93,7 @@ The plugin can log information about its behavior with respect to the Statistics -********** +========== * ``stale_response.swr.hit`` The number of times stale data was served for stale-while-relavidate. * ``stale_response.swr.locked_miss`` The number of times stale data could not be served with stale-while-relavidate because of a lock. @@ -102,7 +102,7 @@ Statistics Example -******* +======= To configure the plugin as a global plugin with a default ``stale-while-revalidate`` and a default ``stale-if-error`` of 30 seconds, add
