Add sketch describing data flow and management (closes #107) - #135
Add sketch describing data flow and management (closes #107)#135LakshithadeSilva wants to merge 13 commits into
Conversation
JimMadge
left a comment
There was a problem hiding this comment.
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.
JimMadge
left a comment
There was a problem hiding this comment.
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.
4407b9d to
f2ca965
Compare
|
Rebased on main and moved the MinIO sketch to a new folder called 'architecture' within docs. |
craddm
left a comment
There was a problem hiding this comment.
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
f2ca965 to
63b8f81
Compare
Added a png of the sketch in addition to the Excalidraw source. Rebased on main. |
|
Now that there are docs on the main branch, we should add a page to hold the figure and some text to explain it. |
closes #107
Add a sketch describing the data flow between the key data storage elements and their layout in a FRIDGE.