Skip to content

Add sketch describing data flow and management (closes #107) - #135

Open
LakshithadeSilva wants to merge 13 commits into
mainfrom
data-layout
Open

Add sketch describing data flow and management (closes #107)#135
LakshithadeSilva wants to merge 13 commits into
mainfrom
data-layout

Conversation

@LakshithadeSilva

@LakshithadeSilva LakshithadeSilva commented Oct 14, 2025

Copy link
Copy Markdown
Collaborator

closes #107
Add a sketch describing the data flow between the key data storage elements and their layout in a FRIDGE.

@JimMadge JimMadge left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having the figure's source is useful, but it isn't an image we can use in docs.
Can you tag your PRs with "closes #" or "fixes #" if it should close an issue, otherwise the automation doesn't work.

We should make sure this connects with the documentation work in #105 and #124.

@LakshithadeSilva @craddm @jakewatson-bristol Let's make sure these connect and close these PRs.
Something like Markdown in a /docs directory is fine for now, we can worry about the document engine later.

@LakshithadeSilva LakshithadeSilva changed the title Add sketch describing data flow and management (#107) Add sketch describing data flow and management (closes #107) Oct 17, 2025

@JimMadge JimMadge left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are docs in main now. Let's put this in an architecture section.

I think we shouldn't remove the newline from the end of the file if excalidraw is going to add it back in if we make any changes.
Should be able to ignore these files in pre-commit.

@LakshithadeSilva

Copy link
Copy Markdown
Collaborator Author

Rebased on main and moved the MinIO sketch to a new folder called 'architecture' within docs.

@craddm
craddm self-requested a review November 4, 2025 11:26

@craddm craddm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What we need here is not only the Excalidraw file, but an image in a suitable format for embedding in a markdown document (e.g. png). We want to have the image appear in the documentation. It's helpful to have the Excalidraw file here too, so we can easily make changes to the image in the future

@LakshithadeSilva

Copy link
Copy Markdown
Collaborator Author

What we need here is not only the Excalidraw file, but an image in a suitable format for embedding in a markdown document (e.g. png). We want to have the image appear in the documentation. It's helpful to have the Excalidraw file here too, so we can easily make changes to the image in the future

Added a png of the sketch in addition to the Excalidraw source. Rebased on main.

Comment thread docs/docs/architecture/data-storage-layout.excalidraw Outdated
@JimMadge

Copy link
Copy Markdown
Member

Now that there are docs on the main branch, we should add a page to hold the figure and some text to explain it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Data flow and management within a FRIDGE

3 participants