From 19cc58532c948e19f83f9606dab4ac8e8f11ccef Mon Sep 17 00:00:00 2001
From: tacheometry <39647014+tacheometry@users.noreply.github.com>
Date: Mon, 12 Feb 2024 01:25:09 +0200
Subject: [PATCH] Add file deletion diagram

---
 .../microsite/docs/diagrams/file-deletion-diagram.mermaid   | 6 ++++++
 modules/microsite/docs/diagrams/file-deletion-diagram.svg   | 1 +
 modules/microsite/docs/doc/configure.md                     | 2 ++
 3 files changed, 9 insertions(+)
 create mode 100644 modules/microsite/docs/diagrams/file-deletion-diagram.mermaid
 create mode 100644 modules/microsite/docs/diagrams/file-deletion-diagram.svg

diff --git a/modules/microsite/docs/diagrams/file-deletion-diagram.mermaid b/modules/microsite/docs/diagrams/file-deletion-diagram.mermaid
new file mode 100644
index 00000000..04e9620e
--- /dev/null
+++ b/modules/microsite/docs/diagrams/file-deletion-diagram.mermaid
@@ -0,0 +1,6 @@
+flowchart LR
+    Create["Share is created"] --> Publish["Share is published"]
+    Publish -- Validity time passes --> Private["Share is made private"]
+    Publish -- Max views reached --> Private
+    
+    Private2["Share is private"] -- Cleanup job runs --> Deleted["Files are deleted"]
diff --git a/modules/microsite/docs/diagrams/file-deletion-diagram.svg b/modules/microsite/docs/diagrams/file-deletion-diagram.svg
new file mode 100644
index 00000000..e7dda447
--- /dev/null
+++ b/modules/microsite/docs/diagrams/file-deletion-diagram.svg
@@ -0,0 +1 @@
+<svg id="mermaid-svg" width="100%" xmlns="http://www.w3.org/2000/svg" style="max-width: 824.140625px;" viewBox="-8 -8 824.140625 146" role="graphics-document document" aria-roledescription="flowchart-v2" xmlns:xlink="http://www.w3.org/1999/xlink"><style>#mermaid-svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg .error-icon{fill:#552222;}#mermaid-svg .error-text{fill:#552222;stroke:#552222;}#mermaid-svg .edge-thickness-normal{stroke-width:2px;}#mermaid-svg .edge-thickness-thick{stroke-width:3.5px;}#mermaid-svg .edge-pattern-solid{stroke-dasharray:0;}#mermaid-svg .edge-pattern-dashed{stroke-dasharray:3;}#mermaid-svg .edge-pattern-dotted{stroke-dasharray:2;}#mermaid-svg .marker{fill:#333333;stroke:#333333;}#mermaid-svg .marker.cross{stroke:#333333;}#mermaid-svg svg{font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;}#mermaid-svg .label{font-family:"trebuchet ms",verdana,arial,sans-serif;color:#333;}#mermaid-svg .cluster-label text{fill:#333;}#mermaid-svg .cluster-label span,#mermaid-svg p{color:#333;}#mermaid-svg .label text,#mermaid-svg span,#mermaid-svg p{fill:#333;color:#333;}#mermaid-svg .node rect,#mermaid-svg .node circle,#mermaid-svg .node ellipse,#mermaid-svg .node polygon,#mermaid-svg .node path{fill:#ECECFF;stroke:#9370DB;stroke-width:1px;}#mermaid-svg .flowchart-label text{text-anchor:middle;}#mermaid-svg .node .label{text-align:center;}#mermaid-svg .node.clickable{cursor:pointer;}#mermaid-svg .arrowheadPath{fill:#333333;}#mermaid-svg .edgePath .path{stroke:#333333;stroke-width:2.0px;}#mermaid-svg .flowchart-link{stroke:#333333;fill:none;}#mermaid-svg .edgeLabel{background-color:#e8e8e8;text-align:center;}#mermaid-svg .edgeLabel rect{opacity:0.5;background-color:#e8e8e8;fill:#e8e8e8;}#mermaid-svg .labelBkg{background-color:rgba(232, 232, 232, 0.5);}#mermaid-svg .cluster rect{fill:#ffffde;stroke:#aaaa33;stroke-width:1px;}#mermaid-svg .cluster text{fill:#333;}#mermaid-svg .cluster span,#mermaid-svg p{color:#333;}#mermaid-svg div.mermaidTooltip{position:absolute;text-align:center;max-width:200px;padding:2px;font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:12px;background:hsl(80, 100%, 96.2745098039%);border:1px solid #aaaa33;border-radius:2px;pointer-events:none;z-index:100;}#mermaid-svg .flowchartTitleText{text-anchor:middle;font-size:18px;fill:#333;}#mermaid-svg :root{--mermaid-font-family:"trebuchet ms",verdana,arial,sans-serif;}</style><g><marker id="mermaid-svg_flowchart-pointEnd" class="marker flowchart" viewBox="0 0 10 10" refX="6" refY="5" markerUnits="userSpaceOnUse" markerWidth="12" markerHeight="12" orient="auto"><path d="M 0 0 L 10 5 L 0 10 z" class="arrowMarkerPath" style="stroke-width: 1; stroke-dasharray: 1, 0;"/></marker><marker id="mermaid-svg_flowchart-pointStart" class="marker flowchart" viewBox="0 0 10 10" refX="4.5" refY="5" markerUnits="userSpaceOnUse" markerWidth="12" markerHeight="12" orient="auto"><path d="M 0 5 L 10 10 L 10 0 z" class="arrowMarkerPath" style="stroke-width: 1; stroke-dasharray: 1, 0;"/></marker><marker id="mermaid-svg_flowchart-circleEnd" class="marker flowchart" viewBox="0 0 10 10" refX="11" refY="5" markerUnits="userSpaceOnUse" markerWidth="11" markerHeight="11" orient="auto"><circle cx="5" cy="5" r="5" class="arrowMarkerPath" style="stroke-width: 1; stroke-dasharray: 1, 0;"/></marker><marker id="mermaid-svg_flowchart-circleStart" class="marker flowchart" viewBox="0 0 10 10" refX="-1" refY="5" markerUnits="userSpaceOnUse" markerWidth="11" markerHeight="11" orient="auto"><circle cx="5" cy="5" r="5" class="arrowMarkerPath" style="stroke-width: 1; stroke-dasharray: 1, 0;"/></marker><marker id="mermaid-svg_flowchart-crossEnd" class="marker cross flowchart" viewBox="0 0 11 11" refX="12" refY="5.2" markerUnits="userSpaceOnUse" markerWidth="11" markerHeight="11" orient="auto"><path d="M 1,1 l 9,9 M 10,1 l -9,9" class="arrowMarkerPath" style="stroke-width: 2; stroke-dasharray: 1, 0;"/></marker><marker id="mermaid-svg_flowchart-crossStart" class="marker cross flowchart" viewBox="0 0 11 11" refX="-1" refY="5.2" markerUnits="userSpaceOnUse" markerWidth="11" markerHeight="11" orient="auto"><path d="M 1,1 l 9,9 M 10,1 l -9,9" class="arrowMarkerPath" style="stroke-width: 2; stroke-dasharray: 1, 0;"/></marker><g class="root"><g class="clusters"/><g class="edgePaths"><path d="M130.734,29L144.986,29C159.237,29,187.74,29,215.359,29C242.978,29,269.714,29,283.082,29L296.45,29" id="L-Create-Publish-0" class=" edge-thickness-normal edge-pattern-solid flowchart-link LS-Create LE-Publish" style="fill:none;" marker-end="url(#mermaid-svg_flowchart-pointEnd)"/><path d="M445.938,20.626L461.902,18.772C477.867,16.917,509.797,13.209,540.848,12.979C571.9,12.749,602.073,15.998,617.159,17.622L632.246,19.247" id="L-Publish-Private-0" class=" edge-thickness-normal edge-pattern-solid flowchart-link LS-Publish LE-Private" style="fill:none;" marker-end="url(#mermaid-svg_flowchart-pointEnd)"/><path d="M445.938,37.374L461.902,39.228C477.867,41.083,509.797,44.791,540.848,45.021C571.9,45.251,602.073,42.002,617.159,40.378L632.246,38.753" id="L-Publish-Private-1" class=" edge-thickness-normal edge-pattern-solid flowchart-link LS-Publish LE-Private" style="fill:none;" marker-end="url(#mermaid-svg_flowchart-pointEnd)"/><path d="M128.609,113L143.215,113C157.82,113,187.031,113,215.691,113C244.351,113,272.459,113,286.513,113L300.567,113" id="L-Private2-Deleted-0" class=" edge-thickness-normal edge-pattern-solid flowchart-link LS-Private2 LE-Deleted" style="fill:none;" marker-end="url(#mermaid-svg_flowchart-pointEnd)"/></g><g class="edgeLabels"><g class="edgeLabel"><g class="label" transform="translate(0, 0)"><foreignObject width="0" height="0"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="edgeLabel"></span></div></foreignObject></g></g><g class="edgeLabel" transform="translate(541.7265625, 9.5)"><g class="label" transform="translate(-70.7890625, -9.5)"><foreignObject width="141.578125" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="edgeLabel">Validity time passes</span></div></foreignObject></g></g><g class="edgeLabel" transform="translate(541.7265625, 48.5)"><g class="label" transform="translate(-67.2890625, -9.5)"><foreignObject width="134.578125" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="edgeLabel">Max views reached</span></div></foreignObject></g></g><g class="edgeLabel" transform="translate(216.2421875, 113)"><g class="label" transform="translate(-60.5078125, -9.5)"><foreignObject width="121.015625" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="edgeLabel">Cleanup job runs</span></div></foreignObject></g></g></g><g class="nodes"><g class="node default default flowchart-label" id="flowchart-Create-0" transform="translate(65.3671875, 29)"><rect class="basic label-container" style="" rx="0" ry="0" x="-65.3671875" y="-17" width="130.734375" height="34"/><g class="label" style="" transform="translate(-57.8671875, -9.5)"><rect/><foreignObject width="115.734375" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="nodeLabel">Share is created</span></div></foreignObject></g></g><g class="node default default flowchart-label" id="flowchart-Publish-1" transform="translate(373.84375, 29)"><rect class="basic label-container" style="" rx="0" ry="0" x="-72.09375" y="-17" width="144.1875" height="34"/><g class="label" style="" transform="translate(-64.59375, -9.5)"><rect/><foreignObject width="129.1875" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="nodeLabel">Share is published</span></div></foreignObject></g></g><g class="node default default flowchart-label" id="flowchart-Private-3" transform="translate(722.828125, 29)"><rect class="basic label-container" style="" rx="0" ry="0" x="-85.3125" y="-17" width="170.625" height="34"/><g class="label" style="" transform="translate(-77.8125, -9.5)"><rect/><foreignObject width="155.625" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="nodeLabel">Share is made private</span></div></foreignObject></g></g><g class="node default default flowchart-label" id="flowchart-Private2-6" transform="translate(65.3671875, 113)"><rect class="basic label-container" style="" rx="0" ry="0" x="-63.2421875" y="-17" width="126.484375" height="34"/><g class="label" style="" transform="translate(-55.7421875, -9.5)"><rect/><foreignObject width="111.484375" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="nodeLabel">Share is private</span></div></foreignObject></g></g><g class="node default default flowchart-label" id="flowchart-Deleted-7" transform="translate(373.84375, 113)"><rect class="basic label-container" style="" rx="0" ry="0" x="-67.9765625" y="-17" width="135.953125" height="34"/><g class="label" style="" transform="translate(-60.4765625, -9.5)"><rect/><foreignObject width="120.953125" height="19"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; white-space: nowrap;"><span class="nodeLabel">Files are deleted</span></div></foreignObject></g></g></g></g></g><style>@import url("https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css");</style><script xmlns="" id="bw-fido2-page-script"/></svg>
\ No newline at end of file
diff --git a/modules/microsite/docs/doc/configure.md b/modules/microsite/docs/doc/configure.md
index 6b63344d..c7a028fd 100644
--- a/modules/microsite/docs/doc/configure.md
+++ b/modules/microsite/docs/doc/configure.md
@@ -553,6 +553,8 @@ information on how it works with other providers.
 
 ## Cleanup
 
+<img src="../diagrams/file-deletion-diagram.svg" class="rounded screenshot">
+
 Sharry has a periodic cleanup job that will delete 'invalid'
 resources. This cleanup job runs in the backend and is triggered
 by a timer every `interval` as defined in the `cleanup` block. It