From 27c85d8df243bb8256719c53ac45b85f6a1c3e12 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Wed, 7 Jul 2021 13:42:13 -0400 Subject: [PATCH] contrib: add docs about the diagrams --- contributing/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/contributing/README.md b/contributing/README.md index e5e96f0b78..75b3fd99e6 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -35,3 +35,18 @@ found in the public [user documentation]. 1. [Multi-Cluster Federation](./cluster-federation) Also see the [FAQ](./faq.md). + +## Contributing to these docs + +This section is meta documentation about contributing to these docs. + +### Diagrams + +The diagrams in these documents are created using the [mermaid-js live editor]. +The [mermaid-js docs] provide a complete reference for how to create and edit +the diagrams. Use the [consul-mermaid-theme.json] (paste it into the Config tab +in the editor) to maintain a consistent Consul style for the diagrams. + +[mermaid-js live editor]: https://mermaid-js.github.io/mermaid-live-editor/edit/ +[mermaid-js docs]: https://mermaid-js.github.io/mermaid/ +[consul-mermaid-theme.json]: ./consul-mermaid-theme.json