[trafficserver] 02/03: docs: add brief description for each config file on index

[js...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jsime pushed a commit to branch master
in repository https://git-dual.apache.org/repos/asf/trafficserver.git

commit c81cb35984158c4b295c4f056136448af07623b0
Author: Jon Sime <js...@apache.org>
AuthorDate: Wed Aug 10 15:57:12 2016 +0000

    docs: add brief description for each config file on index
---
 doc/admin-guide/files/index.en.rst | 58 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/doc/admin-guide/files/index.en.rst b/doc/admin-guide/files/index.en.rst
index 39b902b..893318e 100644
--- a/doc/admin-guide/files/index.en.rst
+++ b/doc/admin-guide/files/index.en.rst
@@ -23,7 +23,7 @@ Configuration Files
 *******************
 
 .. toctree::
-   :maxdepth: 1
+   :hidden:
 
    cache.config.en
    congestion.config.en
@@ -42,3 +42,59 @@ Configuration Files
    storage.config.en
    volume.config.en
 
+:doc:`cache.config.en`
+    Defines if, how, and for what durations |TS| caches objects, based on
+    destinations, clients, URL components, and more.
+
+:doc:`congestion.config.en`
+    Defines network conditions under which clients will receive retry messages
+    instead of |TS| contacting origin servers.
+
+:doc:`hosting.config.en`
+    Allows |TS| administrators to assign cache volumes to specific origin
+    servers or domains.
+
+:doc:`icp.config.en`
+    Defines ICP peers.
+
+:doc:`ip_allow.config.en`
+    Controls access to the |TS| cache based on source IP addresses and networks
+    including limiting individual HTTP methods.
+
+:doc:`log_hosts.config.en`
+    Defines origin servers for which separate logs should be maintained.
+
+:doc:`logs_xml.config.en`
+    Defines custom log file formats, filters, and processing options.
+
+:doc:`metrics.config.en`
+    Defines custom dynamic metrics using Lua scripting.
+
+:doc:`parent.config.en`
+    Configures parent proxies in hierarchical caching layouts.
+
+:doc:`plugin.config.en`
+    Control runtime loadable plugins available to |TS|, as well as their
+    configurations.
+
+:doc:`records.config.en`
+    Contains many configuration variables affecting |TS| operation, both the
+    local node as well as a cluster in which the node may be a member.
+
+:doc:`remap.config.en`
+    Defines mapping rules used by |TS| to properly route all incoming requests.
+
+:doc:`splitdns.config.en`
+    Configures DNS servers to use under specific conditios.
+
+:doc:`ssl_multicert.config.en`
+    Configures |TS| to use different server certificates for SSL termination
+    when listening on multiple addresses or when clients employ SNI.
+
+:doc:`storage.config.en`
+    Configures all storage devices and paths to be used for the |TS| cache.
+
+:doc:`volume.config.en`
+    Defines cache space usage by individual protocols.
+
+

-- 
To stop receiving notification emails like this one, please contact
"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>.