02/08: doc: Define jami-service-type as a variable.

[guix-commits]

apteryx pushed a commit to branch master
in repository guix.

commit 063445792b75e157d3a06eaab258739f6de5a961
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Fri Jan 26 15:20:49 2024 -0500

    doc: Define jami-service-type as a variable.
    
    Using defvar for service types causes them to be part of the index, which is
    useful for discoverability.
    
    * doc/guix.texi (Telephony Services) <jami-service-type>: Define with
    defvar.
    
    Change-Id: I7cbb3b7c84c34a91db689b8698a19ed49ef607b4
---
 doc/guix.texi | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 3854c9f67d..881d9cede3 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -28601,10 +28601,11 @@ services:
 
 @subsubheading Jami
 
-@cindex jami, service
-
-This section describes how to configure a Jami server that can be used
-to host video (or audio) conferences, among other uses.  The following
+@defvar jami-service-type
+The service type for running Jami as a service.  It takes a
+@code{jami-configuration} object as a value, documented below.  This
+section describes how to configure a Jami server that can be used to
+host video (or audio) conferences, among other uses.  The following
 example demonstrates how to specify Jami account archives (backups) to
 be provisioned automatically:
 
@@ -28732,6 +28733,7 @@ Account_username: 
f3345f2775ddfe07a4b0d95daea111d15fbc1199
 The remaining actions should be self-explanatory.
 
 The complete set of available configuration options is detailed below.
+@end defvar
 
 @c TODO: Ideally, the following fragments would be auto-generated at
 @c build time, so that they needn't be manually duplicated.