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

Work in progress.

Author: RayOffiah

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

@@ -10,4 +10,103 @@
 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.
 
+You should also familiarize yourself with the xref:./design-guide.adoc[].
+
+You will also need a code editor or an IDE for editing the YAML configuration file.
+
+You should also have a terminal application running.
+
+== Overview
+
+The Release Note Generator has been designed so that it can be extended to support new Couchbase products without having to
+alter the Python script itself. Adding a new product involves two steps:
+
+. Add the new product release set to `cb_release_notes_config.yaml`.
+. Create a new Jinja template for rendering the AsciiDoc file for your new release note.
+
+To demonstrate this process, we're going to create a new release note configuration for the Sync Gateway product.
+
+NOTE: You should run the following commands from the directory where your Release Notes Generator is installed.
+
+=== Step {counter: step}: Make a copy of your `cb_release_notes_config.yaml` file.
+
+You can make a copy of the file using the following terminal command:
+
+[source, shell]
+----
+cp cb_release_notes_config.yaml cb_release_notes_config.yaml.spare
+----
+
+=== Step {counter: step}: Name your release product
+
+Edit the original `cb_release_notes_config.yaml` file
+and add the new `name` item underneath the `release_settings` section:
+
+[source, yaml]
+----
+release_settings:
+  - name: "Sync Gateway"
+----
+
+=== Step {counter: step}: Define your parameters
+
+The user will need to supply parameters that need to be fed to the script.
+These can vary depending on what's going to appear on the release note,
+and what the JQL will need to gather the tickets.
+The most common parameters are:
+
+[horizontal]
+
+Release number::
+The label that our JQL will use to find the release tag.
+
+Release date::
+This will appear in the release note heading.
+
+File path::
+This is a mandatory item needed for each release set.
+It supplies the name of the AsciiDoc file that the script generates.
+
+Other parameters that the SQL will need, (such as the project name), are fixed values
+and don't need to be parameterized.
+
+[source, yaml]
+----
+release_settings:
+  - name: "Sync Gateway"
+    fields:
+      - name: release_number
+        type: text
+        message: 'Enter the release number:'
+      - name: release_date
+        type: text
+        message: 'Enter the release date (Month Year):'
+      - name: file_path
+        type: file
+        message: 'Enter the file path for the release notes:'
+----
+
+=== Step {counter: step}: Define your JQL statement
+
+Now, you add the URL and the JQL statements used to retrieve the Jira tickets that match your parameters:
+
+[source, yaml]
+----
+release_settings:
+  - name: "Sync Gateway"
+    fields:
+      - name: release_number
+        type: text
+        message: 'Enter the release number:'
+      - name: release_date
+        type: text
+        message: 'Enter the release date (Month Year):'
+      - name: file_path
+        type: file
+        message: 'Enter the file path for the release notes:'
+    url: https://jira.issues.couchbase.com
+    jql: project = CBG AND issuetype in (Bug, "New Feature", Epic, Improvement)
+      AND (fixVersion = {{release_number}} OR labels IN (known_issue))
+      ORDER BY key ASC
+----
 

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

@@ -32,8 +32,10 @@ The script is designed to be flexible and extendable.
 It uses a modular architecture that allows for the addition of new products and formats.
 
 [mermaid]
+.Release Note Generator Process Flow
 ----
 flowchart LR
+
 jira@{shape: disk, label: "Couchbase\n JIRA\n database"}
 script@{shape: process, label: "CB Release Notes Generator\n (Python script)"}
 configuration@{shape: docs, label: "configuration files"}
@@ -47,10 +49,10 @@ configuration CtoS@====> script
 script StoA@====> asciidoc
 user ====> script
 
-JtoS@{animation: slow, curve: linear}
-TtoS@{animation: slow, curve: linear}
-CtoS@{animation: slow, curve: linear}
-StoA@{animation: slow, curve: linear}
+JtoS@{curve: linear}
+TtoS@{curve: linear}
+CtoS@{curve: linear}
+StoA@{curve: linear}
 ----
 
 . On invocation, the script loads the `release sets` from the configuration file,