diff --git a/README.md b/README.md index 36bf66281..34001dea9 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ graph TB In development, backend and updater use the same redis, but in production they are separate. -See also [older graph](documentation/Oodikone.png), which presents more information. +See also the [older graph](documentation/img/oodikone.png) for more information. To read a bit more details about what updater-scheduler and updater-worker do, see their own READMEs: @@ -105,7 +105,9 @@ To read a bit more details about what updater-scheduler and updater-worker do, s ### Documentation -Folder `documentation` currently contains some notes on sis-db schema and is meant as a place for storing useful information on Oodikone to make life easier for future developers. Feel free to add anything relevant! +The `documentation` directory contains some notes on sis-db schema and is meant as a place for storing useful information on Oodikone to make life easier for future developers. Feel free to add anything relevant! + +For internal meeting notes and sensitive information, see Toska GitLab. ### Basics diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 000000000..30143761a --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,3 @@ +# Documentation + +Oodikone public documentation. For internal documentation, see Toska GitLab. diff --git a/documentation/masterplan.jpeg b/documentation/img/masterplan.jpeg similarity index 100% rename from documentation/masterplan.jpeg rename to documentation/img/masterplan.jpeg diff --git a/documentation/Oodikone.png b/documentation/img/oodikone.png similarity index 100% rename from documentation/Oodikone.png rename to documentation/img/oodikone.png diff --git a/documentation/Oodikone.svg b/documentation/img/oodikone.svg similarity index 100% rename from documentation/Oodikone.svg rename to documentation/img/oodikone.svg