Skip to content

Commit 8078fec

Browse files
csvirimetacosmscrocquesel
authored
docs: mermaid support (#1053)
* docs: dependent resources * docs: dr motivation * docs: add flow chart to motivation, detail design * fix: remove now fixed fix-me :) [skip-ci] * fix: missing word Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: re-order sentences Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: clarify Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: split sentence Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: split sentence Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: remove extra word Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: header * fix: simplify dependent logic [skip-ci] * fix: reword [skip ci] Co-authored-by: Attila Mészáros <csviri@gmail.com> * chore: move version to 3.0.0-SNAPSHOT to reflect API breakage (#1051) * docs: mermaid support * fix: mermaid integration * docs: dependent resources * docs: dr motivation * docs: add flow chart to motivation, detail design * fix: remove now fixed fix-me :) [skip-ci] * fix: missing word Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: re-order sentences Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: clarify Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: split sentence Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: split sentence Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: remove extra word Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com> * fix: header * fix: simplify dependent logic [skip-ci] * fix: reword [skip ci] Co-authored-by: Attila Mészáros <csviri@gmail.com> * fix: diagram * fix: flag not needed Co-authored-by: Chris Laprun <metacosm@gmail.com> Co-authored-by: Chris Laprun <metacosm@users.noreply.github.com> Co-authored-by: Sébastien CROCQUESEL <88554524+scrocquesel@users.noreply.github.com>
1 parent 76650a5 commit 8078fec

File tree

4 files changed

+9
-2
lines changed

4 files changed

+9
-2
lines changed

docs/_layouts/docs.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title | escape }}{% endif %}</title>
77
{% include links.html %}
88
{% include analytics.html %}
9+
910
</head>
1011
<body class="page">
1112
{% include navbar.html %}
@@ -20,6 +21,7 @@
2021
<article class="uk-article">
2122
{% include anchor_headings.html html=content anchorBody="#" %}
2223
</article>
24+
<script src="/assets/js/mermaid.min.js"></script>
2325
</div>
2426
</div>
2527
</div>

docs/assets/js/mermaid.min.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/js/mermaid.min.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/documentation/dependent-resources.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ the `Deployment` controller.
2323
Controllers that deal with secondary resources typically need to perform the following steps, for
2424
each secondary resource:
2525

26-
```mermaid
26+
27+
<div class="mermaid" markdown="0">
2728
flowchart TD
2829

2930
compute[Compute desired secondary resource based on primary state] --> A
@@ -35,7 +36,7 @@ match{Matches desired state as defined by primary?}
3536
match -- Yes --> Done
3637
match -- No --> Update --> Done
3738

38-
```
39+
</div>
3940

4041
While these steps are not difficult in and of themselves, there are some subtleties that can lead to
4142
bugs or sub-optimal code if not done right. As this process is pretty much similar for each

0 commit comments

Comments
 (0)