Skip to content

Commit a68c76b

Browse files
committed
[DOC-13702]: Write documentation for the Release Note Generator
1 parent 03c7708 commit a68c76b

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

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

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,26 @@ When deciding on the design of the Couchbase Release Note Generator, the team co
3131
The script is designed to be flexible and extendable.
3232
It uses a modular architecture that allows for the addition of new products and formats.
3333

34-
[plantuml]
34+
[mermaid]
3535
----
36-
@startuml
37-
skin rose
38-
39-
database "Couchbase\n jira \n database" as jira
40-
41-
component "CB Release Notes Generator\n(Python script)" as script
42-
file "Generated\n AsciiDoc\n file" as asciidoc
43-
file "templates\n(Jinja)" as template
44-
file "configuration file\n(YAML)" as configuration
45-
actor "Documentarian" as user
46-
47-
jira --> script
48-
configuration --> script
49-
template --> script
50-
script --> asciidoc
51-
user --> script
52-
@enduml
36+
flowchart LR
37+
jira@{shape: disk, label: "Couchbase\n JIRA\n database"}
38+
script@{shape: process, label: "CB Release Notes Generator\n (Python script)"}
39+
configuration@{shape: docs, label: "configuration files"}
40+
templates@{shape: docs, label: "jinja\ntemplates"}
41+
asciidoc@{shape: lined-document, label: "Generated\n AsciiDoc file"}
42+
user@{ shape: manual-input, label: "Documentarian"}
43+
44+
jira JtoS@====> script
45+
templates TtoS@====> script
46+
configuration CtoS@====> script
47+
script StoA@====> asciidoc
48+
user ====> script
49+
50+
JtoS@{animation: slow, curve: linear}
51+
TtoS@{animation: slow, curve: linear}
52+
CtoS@{animation: slow, curve: linear}
53+
StoA@{animation: slow, curve: linear}
5354
----
5455

5556
. On invocation, the script loads the `release sets` from the configuration file,

0 commit comments

Comments
 (0)