From 33a36121327c366d34022b3df3a78a3b47adfd99 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Fri, 28 Mar 2025 03:18:30 +0000
Subject: doc: Document tissue service.

* doc/forge.skb (Services)[tissue service]: New section.
---
 doc/forge.skb | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

(limited to 'doc/forge.skb')

diff --git a/doc/forge.skb b/doc/forge.skb
index 6e20a67..d62336a 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -292,6 +292,46 @@ shown. Else, they won't.])
            (record-field "extra-options"
              [Association list of additional key-value option pairs to
 include in the generated ,(file [cgitrc]) configuration file])))))
+    (section :title [tissue service]
+             :ident "section-tissue-service"
+      (p [tissue is an issue tracker built on plain text files and
+git. In addition, it features a static site generator tuned to
+building project websites.])
+      (description
+       (record-documentation "guix/forge/tissue.scm" '<tissue-configuration>
+         (record-field "package"
+           [,(code [tissue]) package to use])
+         (record-field "socket"
+           [Socket to listen on. Socket may be a ,(record-ref
+"<forge-ip-socket>"), or ,(record-ref "<forge-unix-socket>")
+object.])
+         (record-field "state-directory"
+           [Directory in which tissue maintains its state])
+         (record-field "hosts"
+           [List of ,(record-ref "<tissue-host>") objects describing
+configured hosts. A single tissue instance may serve several
+hosts—this is often called ,(ref :url
+"https://en.wikipedia.org/wiki/Virtual_hosting" :text "virtual
+hosting").]))
+       (record-documentation "guix/forge/tissue.scm" '<tissue-host>
+         (record-field "name"
+           [HTTP host name to listen on])
+         (record-field "projects"
+           [List of ,(record-ref "<tissue-project>") objects
+describing configured projects]))
+       (record-documentation "guix/forge/tissue.scm" '<tissue-project>
+         (record-field "name"
+           [Name of the project])
+         (record-field "user"
+           [Name of user who owns the project directory in the tissue
+,(record-field-ref "<tissue-configuration>" "state-directory")])
+         (record-field "base-path"
+           [Base web path at which the project is served. Several
+projects may be served on the same host at ,(samp "/project1/"),
+,(samp "/project2/") and so on.]
+           :default [,(samp "\"/<name>/\"")])
+         (record-field "upstream-repository"
+           [Path to git repository of project]))))
     (section :title [forge nginx service]
              :ident "section-forge-nginx-service"
       (p [The forge nginx service is a wrapper around the nginx web
-- 
cgit v1.2.3