diff --git a/README.md b/README.md index 248a478..8eeb8a9 100644 --- a/README.md +++ b/README.md @@ -56,3 +56,4 @@ storyteller-ml ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠉⠛⠶⠦⣤⡷⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀ ``` +User documentation [lives here](_docs/) \ No newline at end of file diff --git a/docs/README.md b/_develop/infrastructure_docs/README.md similarity index 100% rename from docs/README.md rename to _develop/infrastructure_docs/README.md diff --git a/docs/diagrams/jobs1.png b/_develop/infrastructure_docs/diagrams/jobs1.png similarity index 100% rename from docs/diagrams/jobs1.png rename to _develop/infrastructure_docs/diagrams/jobs1.png diff --git a/docs/diagrams/jobs2.png b/_develop/infrastructure_docs/diagrams/jobs2.png similarity index 100% rename from docs/diagrams/jobs2.png rename to _develop/infrastructure_docs/diagrams/jobs2.png diff --git a/docs/diagrams/microservices.png b/_develop/infrastructure_docs/diagrams/microservices.png similarity index 100% rename from docs/diagrams/microservices.png rename to _develop/infrastructure_docs/diagrams/microservices.png diff --git a/_develop/local_development_setup.md b/_develop/local_development_setup.md new file mode 100644 index 0000000..236a4ba --- /dev/null +++ b/_develop/local_development_setup.md @@ -0,0 +1,39 @@ +local development setup +======================= + +Ubuntu 22.04 +------------ + + +### Install Python + +```bash +sudo apt install python3.11-venv +``` + +### Install Docker + +```bash +sudo apt install docker.io + +# Docker requires user group permissions +# This may require a logout to work +sudo groupadd docker +sudo usermod -aG docker ${USER} +newgrp docker + +# Test if Docker works +docker run hello-world +``` + +MacOS +----- + +(TODO) + +Windows +------- + +(Not supported.) + +