[DOC-13702]: Write documentation for the Release Note Generator

Author: RayOffiah

home/modules/contribute/nav.adoc

@@ -39,6 +39,7 @@
 
 * Release Note Generator
  ** xref:release-note-generator/design-guide.adoc[Release Note Generator Design Guide]
+ ** xref:release-note-generator/adding-a-new-product.adoc[Adding a New Product]
 
 
 //* Additional Resources (Pending)

home/modules/contribute/pages/release-note-generator/adding-a-new-product.adoc

@@ -0,0 +1,13 @@
+= Adding a New Product
+:description: Demonstrates how to add a new product to the Release Note Generator.
+:page-pagination: prev
+:page-topic-type: howto
+
+[abstract]
+{description}
+
+== Prerequisites
+This guide is intended for technical writers and developers who are familiar with the Release Note Generator. If you are new to the tool, please refer to the link:https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/3338961232/Other+Tools[installation and use of the Release Note Generator] guide for more information.
+Before you begin, make sure that you have the release note generator installed and running.
+
+

home/modules/contribute/pages/release-note-generator/design-guide.adoc

@@ -1,9 +1,9 @@
 = Couchbase Release Note Generator Design Guide
 :description: This document describes the architecture and high-level design of the Couchbase Release Note Generator.
-:page-topic-type: concepts
+:page-topic-type: concept
+:page-pagination: next
 
-:jql-fn: footnote:[JIRA Query Language]
-:jinja-fn: footnote:[For more information on Jinja templates, see https://jinja.palletsprojects.com]
+:jql-fn: footnote:jql-footnote[JIRA Query Language]
 [abstract]
 {description}
 
@@ -57,9 +57,10 @@ StoA@{animation: slow, curve: linear}
 and displays them on screen.
 . The user selects one of the release sets (`Couchbase Server`, `Couchbase Mobile`, `Couchbase Operator` ...)
 . The user enters a series of parameters as defined in the selected `release set`: (`release date`, `release label` ...)
-.The script executes the JQL{empty}{jql-fn} statement defined in the `release set` supplying the parameters entered by the user.
+.The script executes the JQL{empty}{jql-fn} statement defined in the `release set`,
+supplying the parameters entered by the user.
 . The script collects the JIRA tickets that match the query.
-. The script loads the Jinja{empty}{jinja-fn} template defined in the release set and uses it to render the release note as an AsciiDoc file.
+. The script loads the Jinja template defined in the release set and uses it to render the release note as an AsciiDoc file.
 
 
 == Logic Flow
@@ -96,7 +97,7 @@ release_settings:
 
 ----
 
-At this high-level, the contents of the configuration file are pretty straightforward:
+At this high level, the contents of the configuration file are pretty straightforward:
 
 [horizontal]
 version::
@@ -112,7 +113,7 @@ The location of the JinJa templates that the script will use to render the relea
 jira_batch_size::
 Instead of fetching the Jira tickets in one go, the script can retrieve them in batches of a given size.
 +
-NOTE: In practice, a release note shouldn't contain more that 50 tickets,
+NOTE: In practice, a release note shouldn't contain more than 50 tickets,
 so there is probably little point in changing the value.
 
 release_settings::
@@ -188,6 +189,7 @@ The prompt that is displayed for the user to enter the required information.
 In our example, the prompts displayed will look something like this,
 each item being filled in by the user before the script displays the next prompt.
 
+.Get parameters from the user
 image::release-note-generator/retrieve-parameters.png[]
 
 TIP: The script will save the parameters as they're entered,
@@ -226,13 +228,41 @@ the API will only retrieve items that have a security level set to `public` or `
 ====
 
 jql::
-A valid JQL statement that the script will use to retrieve the tickets.
+A valid JQL{empty}footnote:jql-footnote[] statement that the script will use to retrieve the tickets.
 Pay close attention to the field parameters delimited by `{{}}`;
 these are the named parameters that will be replaced with the values
 entered by the user from the xref:#fields[`fields`] section.
 
 === Step {counter:flow}: Render the release note
 
+Having retrieved the tickets that match the JQL,
+the script will pick up the template designated for the release set.
+
+[source, yaml]
+----
+template: couchbase-server-bug-fixes.jinja2
+----
+
+[NOTE]
+.Remember the `templates` location!
+====
+The location of the Jinja templates is defined in the `templates` section of the configuration file.
+====
+
+The script will take the collection of tickets and run them through the template, producing the final AsciiDoc file.
+
+NOTE: The Jinja template system is very similar to template engines such as JSP, ASP, and ThymeLeaf.
+The scope of its function is beyond the scope of this design guide,
+but you can find information and tutorials at https://jinja.palletsprojects.com
+
+== Further reading
+
+For more information on Jinja templates, refer to the official documentation at link:https://jinja.palletsprojects.com[].
+
+We have also created a guide for developers on link:https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/3230269470/A+Developer+s+Guide+to+Release+Notes[how to prepare Jira tickets for inclusion in release notes].
+
+There is also a guide for technical writers covering the link:https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/3338961232/Other+Tools[installation and use of the Release Note Generator].
+
 
 
 

kroki/docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3"
 services:
   kroki:
     image: yuzutech/kroki
@@ -14,19 +13,24 @@ services:
       - KROKI_EXCALIDRAW_HOST=excalidraw
     ports:
       - "9500:8000"
+    restart: always
   blockdiag:
     image: yuzutech/kroki-blockdiag
     expose:
       - "8001"
+    restart: always
   mermaid:
     image: yuzutech/kroki-mermaid
     expose:
       - "8002"
+    restart: always
   bpmn:
     image: yuzutech/kroki-bpmn
     expose:
       - "8003"
+    restart: always
   excalidraw:
     image: yuzutech/kroki-excalidraw
     expose:
       - "8004"
+    restart: always