doc

hardisgroupcom · Dec 22, 2024 · cd15b9c · cd15b9c
1 parent d2b13f7
commit cd15b9c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/docs/assets/images/screenshot-flow-doc.jpg b/docs/assets/images/screenshot-flow-doc.jpg
diff --git a/src/commands/hardis/doc/project2markdown.ts b/src/commands/hardis/doc/project2markdown.ts
@@ -40,6 +40,10 @@ To generate Flow documentations, this command requires @mermaid-js/mermaid-cli
 
 Both modes will be tried by default, but you can also force one of them by defining environment variable \`MERMAID_MODES=docker\` or \`MERMAID_MODES=cli\`
 
+_sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/puppeteer: if you can help, please sumit a PR !_
+
+![Screenshot flow doc](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-flow-doc.jpg)
+
 ![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc.jpg)
 
 ![Screenshot project documentation](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-project-doc-2.jpg)

diff --git a/src/commands/hardis/org/monitor/backup.ts b/src/commands/hardis/org/monitor/backup.ts
@@ -47,6 +47,10 @@ As we can retrieve only 10000 files by call, the list of all metadatas will be c
 ## In CI/CD
 
 This command is part of [sfdx-hardis Monitoring](${CONSTANTS.DOC_URL_ROOT}/salesforce-monitoring-metadata-backup/) and can output Grafana, Slack and MsTeams Notifications.
+
+## Documentation
+
+[Doc generation (including visual flows)](${CONSTANTS.DOC_URL_ROOT}/hardis/doc/project2markdown/) is triggered at the end of the command.
 `;
 
   public static examples = [