From cec8dba9eab44f61f130da30f3c0e4fcc70ccdb4 Mon Sep 17 00:00:00 2001 From: Monique Rio Date: Tue, 28 Jan 2025 09:36:04 -0500 Subject: [PATCH] adds hathifiles documentation too --- docs/hathifiles/diagrams.md | 19 +++++++++++++++++++ docs/hathifiles/index.rst | 4 ++++ docs/index.rst | 1 + 3 files changed, 24 insertions(+) create mode 100644 docs/hathifiles/diagrams.md create mode 100644 docs/hathifiles/index.rst diff --git a/docs/hathifiles/diagrams.md b/docs/hathifiles/diagrams.md new file mode 100644 index 0000000..51fbe34 --- /dev/null +++ b/docs/hathifiles/diagrams.md @@ -0,0 +1,19 @@ +# Hathifiles Diagrams + +```mermaid +flowchart TD + +p[Poll] +ht["HathiTrust"] +w["Webhook"] +bus["Event bus"] +u["Update workflow"] +db["Hathifiles Mysql DB"] + +p--"Is there a new update file?"-->ht +p--"These are the new files"-->w +w--"Here are the new update files"-->bus +bus--"You need to process these files"-->u +u--"pulls files"-->ht +u--"update with this data"-->db +``` diff --git a/docs/hathifiles/index.rst b/docs/hathifiles/index.rst new file mode 100644 index 0000000..c275451 --- /dev/null +++ b/docs/hathifiles/index.rst @@ -0,0 +1,4 @@ +Hathifiles +================= +.. toctree:: + diagrams \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 19db6ed..24fba3a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,5 +16,6 @@ documentation for details. :caption: Contents: api/aim + hathifiles/index digifeeds/index future_projects/index \ No newline at end of file