Skip to content

docs: mermaid support #1053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 33 commits into from
Mar 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
33155ed
docs: dependent resources
csviri Mar 11, 2022
b66fa9e
docs: dr motivation
csviri Mar 18, 2022
671f9bf
docs: add flow chart to motivation, detail design
metacosm Mar 18, 2022
8e89c61
fix: remove now fixed fix-me :)
metacosm Mar 18, 2022
7235a96
fix: missing word
metacosm Mar 21, 2022
8b1878b
fix: re-order sentences
metacosm Mar 21, 2022
6dc9924
fix: clarify
metacosm Mar 21, 2022
d6fe862
fix: split sentence
metacosm Mar 21, 2022
4ad2f55
fix: split sentence
metacosm Mar 21, 2022
21a4385
fix: remove extra word
metacosm Mar 21, 2022
c4f031b
fix: header
csviri Mar 21, 2022
2d3e7e8
fix: simplify dependent logic [skip-ci]
metacosm Mar 21, 2022
8728633
fix: reword
metacosm Mar 21, 2022
f0b80b4
chore: move version to 3.0.0-SNAPSHOT to reflect API breakage (#1051)
metacosm Mar 21, 2022
80529f3
docs: mermaid support
csviri Mar 21, 2022
01346ae
fix: mermaid integration
csviri Mar 21, 2022
45aa0ab
docs: dependent resources
csviri Mar 11, 2022
a7e5e08
docs: dr motivation
csviri Mar 18, 2022
aaf9e63
docs: add flow chart to motivation, detail design
metacosm Mar 18, 2022
c66c5b8
fix: remove now fixed fix-me :)
metacosm Mar 18, 2022
4a5db14
fix: missing word
metacosm Mar 21, 2022
e422b2a
fix: re-order sentences
metacosm Mar 21, 2022
ba3122a
fix: clarify
metacosm Mar 21, 2022
a61c054
fix: split sentence
metacosm Mar 21, 2022
c8c6382
fix: split sentence
metacosm Mar 21, 2022
4c7fe86
fix: remove extra word
metacosm Mar 21, 2022
badc61c
fix: header
csviri Mar 21, 2022
37c8796
fix: simplify dependent logic [skip-ci]
metacosm Mar 21, 2022
9453108
fix: reword
metacosm Mar 21, 2022
ceaee19
Merge branch 'docs-dependent-resources' into mermaid-in-docs
csviri Mar 21, 2022
d8c8b24
fix: diagram
csviri Mar 21, 2022
165288e
fix: flag not needed
csviri Mar 21, 2022
c392542
Merge branch 'next' into mermaid-in-docs
csviri Mar 22, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title | escape }}{% endif %}</title>
{% include links.html %}
{% include analytics.html %}

</head>
<body class="page">
{% include navbar.html %}
Expand All @@ -20,6 +21,7 @@
<article class="uk-article">
{% include anchor_headings.html html=content anchorBody="#" %}
</article>
<script src="/assets/js/mermaid.min.js"></script>
</div>
</div>
</div>
Expand Down
3 changes: 3 additions & 0 deletions docs/assets/js/mermaid.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/assets/js/mermaid.min.js.map

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/documentation/dependent-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ the `Deployment` controller.
Controllers that deal with secondary resources typically need to perform the following steps, for
each secondary resource:

```mermaid

<div class="mermaid" markdown="0">
flowchart TD

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

```
</div>

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