Merge pull request #1320 from tacheometry/current-docs

Add file deletion diagram
eikek · Feb 12, 2024 · ac68ccc · ac68ccc
2 parents c06d164 + 19cc585
commit ac68ccc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/modules/microsite/docs/diagrams/file-deletion-diagram.mermaid 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
diff --git 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