[master] e0624cda8 doc: Promote design patterns to a top level section
Dridi Boukelmoune
dridi.boukelmoune at gmail.com
Tue Sep 7 12:03:05 UTC 2021
commit e0624cda8c8db86366a89a8c4eb12fe5a671f37d
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date: Tue Sep 7 12:53:22 2021 +0200
doc: Promote design patterns to a top level section
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
index a017cf10a..8a1522a31 100644
--- a/doc/sphinx/index.rst
+++ b/doc/sphinx/index.rst
@@ -74,6 +74,7 @@ Longer listings like example command output and VCL look like this::
tutorial/index.rst
users-guide/index.rst
reference/index.rst
+ vcl-design-patterns/index.rst
whats-new/index.rst
dev-guide/index.rst
phk/index.rst
diff --git a/doc/sphinx/reference/index.rst b/doc/sphinx/reference/index.rst
index c5c751019..63bc4db88 100644
--- a/doc/sphinx/reference/index.rst
+++ b/doc/sphinx/reference/index.rst
@@ -9,6 +9,8 @@
The Varnish Reference Manual
%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+.. _reference-vcl:
+
The VCL language
----------------
@@ -21,13 +23,8 @@ The VCL language
VCL backend health probe <vcl-probe>
states.rst
-VCL Design Patterns
--------------------
-
-.. toctree::
- :maxdepth: 1
-
- dp_vcl_resp_status.rst
+A collection of :ref:`vcl-design-patterns-index` is available in addition to
+these reference manuals.
Bundled VMODs
-------------
diff --git a/doc/sphinx/vcl-design-patterns/index.rst b/doc/sphinx/vcl-design-patterns/index.rst
new file mode 100644
index 000000000..ed903ffa9
--- /dev/null
+++ b/doc/sphinx/vcl-design-patterns/index.rst
@@ -0,0 +1,19 @@
+..
+ Copyright (c) 2021 Varnish Software AS
+ SPDX-License-Identifier: BSD-2-Clause
+ See LICENSE file for full text of license
+
+.. _vcl-design-patterns-index:
+
+%%%%%%%%%%%%%%%%%%%
+VCL Design Patterns
+%%%%%%%%%%%%%%%%%%%
+
+This section showcases design patterns for :ref:`reference-vcl`. To keep code
+examples short, some aspects not directly related to a given design pattern
+may be simplified.
+
+.. toctree::
+ :maxdepth: 1
+
+ resp-status.rst
diff --git a/doc/sphinx/reference/dp_vcl_resp_status.rst b/doc/sphinx/vcl-design-patterns/resp-status.rst
similarity index 100%
rename from doc/sphinx/reference/dp_vcl_resp_status.rst
rename to doc/sphinx/vcl-design-patterns/resp-status.rst
More information about the varnish-commit
mailing list