1168 add contents to docs (#1188)

* add dev handbook * add dev setup * mkdocs
clowder-framework · Aug 29, 2024 · 90d65ed · 90d65ed
1 parent 8c9eb8a
commit 90d65ed
Show file tree

Hide file tree

Showing 68 changed files with 1,492 additions and 2 deletions.
diff --git a/docs/docs/devs/devhandbook.md b/docs/docs/devs/devhandbook.md
diff --git a/docs/docs/devs/devhandbookmedia/image1.png b/docs/docs/devs/devhandbookmedia/image1.png
diff --git a/docs/docs/devs/devhandbookmedia/image10.png b/docs/docs/devs/devhandbookmedia/image10.png
diff --git a/docs/docs/devs/devhandbookmedia/image11.png b/docs/docs/devs/devhandbookmedia/image11.png
diff --git a/docs/docs/devs/devhandbookmedia/image12.png b/docs/docs/devs/devhandbookmedia/image12.png
diff --git a/docs/docs/devs/devhandbookmedia/image13.png b/docs/docs/devs/devhandbookmedia/image13.png
diff --git a/docs/docs/devs/devhandbookmedia/image14.png b/docs/docs/devs/devhandbookmedia/image14.png
diff --git a/docs/docs/devs/devhandbookmedia/image2.png b/docs/docs/devs/devhandbookmedia/image2.png
diff --git a/docs/docs/devs/devhandbookmedia/image3.png b/docs/docs/devs/devhandbookmedia/image3.png
diff --git a/docs/docs/devs/devhandbookmedia/image4.png b/docs/docs/devs/devhandbookmedia/image4.png
diff --git a/docs/docs/devs/devhandbookmedia/image5.png b/docs/docs/devs/devhandbookmedia/image5.png
diff --git a/docs/docs/devs/devhandbookmedia/image6.png b/docs/docs/devs/devhandbookmedia/image6.png
diff --git a/docs/docs/devs/devhandbookmedia/image7.png b/docs/docs/devs/devhandbookmedia/image7.png
diff --git a/docs/docs/devs/devhandbookmedia/image8.png b/docs/docs/devs/devhandbookmedia/image8.png
diff --git a/docs/docs/devs/devhandbookmedia/image9.png b/docs/docs/devs/devhandbookmedia/image9.png
diff --git a/docs/docs/devs/devsetup.md b/docs/docs/devs/devsetup.md
diff --git a/docs/docs/devs/devsetupmedia/image1.png b/docs/docs/devs/devsetupmedia/image1.png
diff --git a/docs/docs/devs/devsetupmedia/image10.png b/docs/docs/devs/devsetupmedia/image10.png
diff --git a/docs/docs/devs/devsetupmedia/image11.png b/docs/docs/devs/devsetupmedia/image11.png
diff --git a/docs/docs/devs/devsetupmedia/image12.png b/docs/docs/devs/devsetupmedia/image12.png
diff --git a/docs/docs/devs/devsetupmedia/image13.png b/docs/docs/devs/devsetupmedia/image13.png
diff --git a/docs/docs/devs/devsetupmedia/image14.png b/docs/docs/devs/devsetupmedia/image14.png
diff --git a/docs/docs/devs/devsetupmedia/image15.png b/docs/docs/devs/devsetupmedia/image15.png
diff --git a/docs/docs/devs/devsetupmedia/image16.png b/docs/docs/devs/devsetupmedia/image16.png
diff --git a/docs/docs/devs/devsetupmedia/image17.png b/docs/docs/devs/devsetupmedia/image17.png
diff --git a/docs/docs/devs/devsetupmedia/image18.png b/docs/docs/devs/devsetupmedia/image18.png
diff --git a/docs/docs/devs/devsetupmedia/image19.png b/docs/docs/devs/devsetupmedia/image19.png
diff --git a/docs/docs/devs/devsetupmedia/image2.png b/docs/docs/devs/devsetupmedia/image2.png
diff --git a/docs/docs/devs/devsetupmedia/image20.png b/docs/docs/devs/devsetupmedia/image20.png
diff --git a/docs/docs/devs/devsetupmedia/image21.png b/docs/docs/devs/devsetupmedia/image21.png
diff --git a/docs/docs/devs/devsetupmedia/image22.png b/docs/docs/devs/devsetupmedia/image22.png
diff --git a/docs/docs/devs/devsetupmedia/image23.png b/docs/docs/devs/devsetupmedia/image23.png
diff --git a/docs/docs/devs/devsetupmedia/image24.png b/docs/docs/devs/devsetupmedia/image24.png
diff --git a/docs/docs/devs/devsetupmedia/image25.png b/docs/docs/devs/devsetupmedia/image25.png
diff --git a/docs/docs/devs/devsetupmedia/image26.png b/docs/docs/devs/devsetupmedia/image26.png
diff --git a/docs/docs/devs/devsetupmedia/image27.png b/docs/docs/devs/devsetupmedia/image27.png
diff --git a/docs/docs/devs/devsetupmedia/image28.png b/docs/docs/devs/devsetupmedia/image28.png
diff --git a/docs/docs/devs/devsetupmedia/image29.png b/docs/docs/devs/devsetupmedia/image29.png
diff --git a/docs/docs/devs/devsetupmedia/image3.png b/docs/docs/devs/devsetupmedia/image3.png
diff --git a/docs/docs/devs/devsetupmedia/image30.png b/docs/docs/devs/devsetupmedia/image30.png
diff --git a/docs/docs/devs/devsetupmedia/image31.png b/docs/docs/devs/devsetupmedia/image31.png
diff --git a/docs/docs/devs/devsetupmedia/image32.png b/docs/docs/devs/devsetupmedia/image32.png
diff --git a/docs/docs/devs/devsetupmedia/image33.png b/docs/docs/devs/devsetupmedia/image33.png
diff --git a/docs/docs/devs/devsetupmedia/image34.png b/docs/docs/devs/devsetupmedia/image34.png
diff --git a/docs/docs/devs/devsetupmedia/image35.png b/docs/docs/devs/devsetupmedia/image35.png
diff --git a/docs/docs/devs/devsetupmedia/image36.png b/docs/docs/devs/devsetupmedia/image36.png
diff --git a/docs/docs/devs/devsetupmedia/image37.png b/docs/docs/devs/devsetupmedia/image37.png
diff --git a/docs/docs/devs/devsetupmedia/image38.png b/docs/docs/devs/devsetupmedia/image38.png
diff --git a/docs/docs/devs/devsetupmedia/image39.png b/docs/docs/devs/devsetupmedia/image39.png
diff --git a/docs/docs/devs/devsetupmedia/image4.png b/docs/docs/devs/devsetupmedia/image4.png
diff --git a/docs/docs/devs/devsetupmedia/image40.png b/docs/docs/devs/devsetupmedia/image40.png
diff --git a/docs/docs/devs/devsetupmedia/image41.png b/docs/docs/devs/devsetupmedia/image41.png
diff --git a/docs/docs/devs/devsetupmedia/image42.png b/docs/docs/devs/devsetupmedia/image42.png
diff --git a/docs/docs/devs/devsetupmedia/image43.png b/docs/docs/devs/devsetupmedia/image43.png
diff --git a/docs/docs/devs/devsetupmedia/image44.png b/docs/docs/devs/devsetupmedia/image44.png
diff --git a/docs/docs/devs/devsetupmedia/image45.png b/docs/docs/devs/devsetupmedia/image45.png
diff --git a/docs/docs/devs/devsetupmedia/image46.png b/docs/docs/devs/devsetupmedia/image46.png
diff --git a/docs/docs/devs/devsetupmedia/image47.png b/docs/docs/devs/devsetupmedia/image47.png
diff --git a/docs/docs/devs/devsetupmedia/image48.png b/docs/docs/devs/devsetupmedia/image48.png
diff --git a/docs/docs/devs/devsetupmedia/image49.png b/docs/docs/devs/devsetupmedia/image49.png
diff --git a/docs/docs/devs/devsetupmedia/image5.png b/docs/docs/devs/devsetupmedia/image5.png
diff --git a/docs/docs/devs/devsetupmedia/image50.png b/docs/docs/devs/devsetupmedia/image50.png
diff --git a/docs/docs/devs/devsetupmedia/image51.png b/docs/docs/devs/devsetupmedia/image51.png
diff --git a/docs/docs/devs/devsetupmedia/image6.png b/docs/docs/devs/devsetupmedia/image6.png
diff --git a/docs/docs/devs/devsetupmedia/image7.png b/docs/docs/devs/devsetupmedia/image7.png
diff --git a/docs/docs/devs/devsetupmedia/image8.png b/docs/docs/devs/devsetupmedia/image8.png
diff --git a/docs/docs/devs/devsetupmedia/image9.png b/docs/docs/devs/devsetupmedia/image9.png
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -8,16 +8,20 @@ nav:
       - Visualizations: users/visualizations.md
   - Developers:
       - Getting started: devs/getstarted.md
+      - Development Environment Setup: devs/devsetup.md
+      - Development Handbook: devs/devhandbook.md
       - Architecture: devs/architecture.md
       - Frontend:
         - devs/frontend/lazyloading.md
       - Keycloak: devs/keycloak.md
-      - Metadata: devs/metadata.md
       - Mongo: devs/mongo-fastapi.md
       - PyCharm: devs/pycharm.md
       - Elasticsearch: devs/elasticsearch.md
-      - Listeners: devs/listeners.md
       - Standalone Docker Deployment: devs/standalone-docker-deployment.md
+      - Design Docs:
+          - Listeners: devs/listeners.md
+          - Metadata: devs/metadata.md
+          - Dataset Versioning: devs/dataset-versioning.md
       - Proposals:
         - Storage: devs/storage.md
   - Admins: