From 275a68f8ab6df00181555949b9284f8d43f8039c Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Thu, 10 Aug 2023 09:46:44 +0100
Subject: doc: Move gunicorn service documentation to Services chapter.

* doc/forge.skb (Reference): Move gunicorn service documentation to
...
(Services)[Specialized application deployment services]{gunicorn
service}: ... new subsection.
---
 doc/forge.skb | 60 ++++++++++++++++++++++++++++++++---------------------------
 1 file changed, 33 insertions(+), 27 deletions(-)

(limited to 'doc')

diff --git a/doc/forge.skb b/doc/forge.skb
index 71887d4..be1260c 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -424,7 +424,39 @@ should be set in the execution environment to their values])
            (record-field "mappings"
              [List of ,(code [<file-system-mapping>]) objects
 describing additional directories that should be shared with the
-container fcgiwrap is run in]))))))
+container fcgiwrap is run in]))))
+      (subsection :title [gunicorn service]
+        (p [gunicorn is a specialized web server for Python ,(ref :url
+"https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface" :text
+"WSGI") applications. We run separate containerized instances of
+gunicorn for each application.])
+        (description
+         (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-configuration>
+           (record-field "package"
+             [,(code [gunicorn]) package to use])
+           (record-field "apps"
+             [List of ,(record-ref "<gunicorn-app>") objects describing
+gunicorn apps to run]))
+         (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-app>
+           (record-field "name"
+             [Name of the app])
+           (record-field "package"
+             [Package of the app])
+           (record-field "wsgi-app-module"
+             [WSGI app module passed to gunicorn])
+           (record-field "sockets"
+             [List of ,(record-ref "<forge-host-socket>"), ,(record-ref
+"<forge-ip-socket>") or ,(record-ref "<forge-unix-socket>") objects
+describing sockets to listen on])
+           (record-field "workers"
+             [Number of worker processes])
+           (record-field "environment-variables"
+             [Association list mapping environment variables that should
+be set in the execution environment to their values])
+           (record-field "mappings"
+             [List of ,(code [<file-system-mapping>]) objects describing
+additional directories that should be shared with the container
+gunicorn is run in]))))))
   (chapter :title [Reference]
            :ident "chapter-reference"
     (description
@@ -501,32 +533,6 @@ respectively. The any address is ,(code ["0.0.0.0"]) and ,(code
      (record-documentation "guix/forge/socket.scm" '<forge-unix-socket>
        (record-field "path"
          [Path to socket file.]))
-     (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-configuration>
-       (record-field "package"
-         [,(code [gunicorn]) package to use])
-       (record-field "apps"
-         [List of ,(record-ref "<gunicorn-app>") objects describing
-gunicorn apps to run]))
-     (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-app>
-       (record-field "name"
-         [Name of the app])
-       (record-field "package"
-         [Package of the app])
-       (record-field "wsgi-app-module"
-         [WSGI app module passed to gunicorn])
-       (record-field "sockets"
-         [List of ,(record-ref "<forge-host-socket>"), ,(record-ref
-"<forge-ip-socket>") or ,(record-ref "<forge-unix-socket>") objects
-describing sockets to listen on])
-       (record-field "workers"
-         [Number of worker processes])
-       (record-field "environment-variables"
-         [Association list mapping environment variables that should
-be set in the execution environment to their values])
-       (record-field "mappings"
-         [List of ,(code [<file-system-mapping>]) objects describing
-additional directories that should be shared with the container
-gunicorn is run in]))
      (record-documentation "guix/forge/webhook.scm" '<webhook-configuration>
        (record-field "package"
          [,(code [webhook]) package to use])
-- 
cgit v1.2.3