Merge pull request #88 from MichaelClifford/restructure

restructure docs directory and toc
aicoe-aiops · Dec 15, 2021 · e079266 · e079266
2 parents c347458 + cf4417e
commit e079266
Show file tree

Hide file tree

Showing 21 changed files with 53 additions and 12 deletions.
diff --git a/_toc.yml b/_toc.yml
@@ -1,17 +1,34 @@
 format: jb-book
 root: README
 parts:
-  - caption: Getting started
+  - caption: Setup Environment
     chapters:
-    - file: docs/getting-started
-    - file: docs/how-to-contribute
-  - caption: AIOps projects
+    - file: docs/setup_environment/odh_and_opf
+    - file: docs/setup_environment/JH_access
+    - file: docs/setup_environment/remote-storage
+    - file: docs/setup_environment/thoth 
+
+  - caption: Develop + Collaborate
     chapters:
-    - file: docs/aiops-projects
-    - file: docs/project-document-template
-    - file: docs/project-structure
-  - caption: Best Practices and Guidelines
-    chapters:
-    - file: docs/guidelines-for-reviewing-datascience-code.md
-    - file: docs/data-visualization-best-practices.md
-    - file: docs/create_and_deploy_jh_image.md
+    - file: docs/develop_collaborate/automated-pipelines   
+    - file: docs/develop_collaborate/thoth-tools
+    - file: docs/develop_collaborate/create_and_deploy_jh_image
+    - file: docs/develop_collaborate/meteorize
+
+  - caption: Visualization
+    chapters: 
+    - file: docs/visualization/data-visualization-best-practices
+
+  - caption: Serving + Monitoring
+    chapters: 
+    - file: docs/serving_monitoring/deploy-models-using-seldon
+    - file: docs/serving_monitoring/monitoring-jh
+
+  - caption: Project Structure
+    chapters: 
+    - file: docs/project_structure/getting_started
+    - file: docs/project_structure/project-structure
+    - file: docs/project_structure/project-document-template
+    - file: docs/project_structure/how-to-contribute
+    - file: docs/project_structure/boards-and-issues
+    - file: docs/project_structure/guidelines-for-reviewing-datascience-code
diff --git a/docs/develop_collaborate/automated-pipelines.md b/docs/develop_collaborate/automated-pipelines.md
@@ -0,0 +1,3 @@
+### **Creating Automated Model Workflows**
+
+To automate your notebook workflows using Elyra and Kubeflow Pipelines on Open Data Hub, you can refer to the [guide](https://github.com/AICoE/elyra-aidevsecops-tutorial) and view our video [tutorial](https://www.youtube.com/watch?v=iMSOal8wRj4). 
diff --git a/docs/automating-via-argo-blog.adoc → ...collaborate/automating-via-argo-blog.adoc b/docs/automating-via-argo-blog.adoc → ...collaborate/automating-via-argo-blog.adoc
diff --git a/docs/create_and_deploy_jh_image.md → ...collaborate/create_and_deploy_jh_image.md b/docs/create_and_deploy_jh_image.md → ...collaborate/create_and_deploy_jh_image.md
diff --git a/docs/develop_collaborate/meteorize.md b/docs/develop_collaborate/meteorize.md
@@ -0,0 +1,3 @@
+ **How to Meteorize the repository**
+    - To meteorize your github repository, first start with making a jupyterbook. You can refer to the tutorial [here.](https://github.com/AICoE/meteor/blob/main/docs/build-jupyterbooks.md) 
+    - After you have the jupyterbook ready, head to [meteor](https://shower.meteor.zone/) to meteorize the project repository.
diff --git a/docs/thoth-tools.md → docs/develop_collaborate/thoth-tools.md b/docs/thoth-tools.md → docs/develop_collaborate/thoth-tools.md
diff --git a/docs/aiops-projects.md → docs/project_structure/aiops-projects.md b/docs/aiops-projects.md → docs/project_structure/aiops-projects.md
diff --git a/docs/boards-and-issues.md → docs/project_structure/boards-and-issues.md b/docs/boards-and-issues.md → docs/project_structure/boards-and-issues.md
diff --git a/docs/data-science-workflow-blog.adoc → ...structure/data-science-workflow-blog.adoc b/docs/data-science-workflow-blog.adoc → ...structure/data-science-workflow-blog.adoc
diff --git a/docs/getting-started.md → docs/project_structure/getting-started.md b/docs/getting-started.md → docs/project_structure/getting-started.md
diff --git a/...delines-for-reviewing-datascience-code.md → ...delines-for-reviewing-datascience-code.md b/...delines-for-reviewing-datascience-code.md → ...delines-for-reviewing-datascience-code.md
diff --git a/docs/how-to-contribute.md → docs/project_structure/how-to-contribute.md b/docs/how-to-contribute.md → docs/project_structure/how-to-contribute.md
diff --git a/docs/project-document-template.md → ...ct_structure/project-document-template.md b/docs/project-document-template.md → ...ct_structure/project-document-template.md
diff --git a/docs/project-structure.md → docs/project_structure/project-structure.md b/docs/project-structure.md → docs/project_structure/project-structure.md
diff --git a/docs/deploy-models-using-seldon.md → ..._monitoring/deploy-models-using-seldon.md b/docs/deploy-models-using-seldon.md → ..._monitoring/deploy-models-using-seldon.md
diff --git a/docs/serving_monitoring/monitor-jh.md b/docs/serving_monitoring/monitor-jh.md
@@ -0,0 +1,8 @@
+* **How to Monitor JupyterHub workloads using Grafana dashboards** 
+    -  (Video tutorial forthcoming)
+    -  To troubleshoot issues while running your notebooks, you can refer to the [Troubleshooting Runbooks][12]
+    -  You can refer the existing [Grafana dashboard][13] for monitoring your Jupyterhub workloads such as CPU, RAM usage, percentage PVC usage.
+
+    [12]: https://www.operate-first.cloud/hitchhikers-guide/apps/docs/odh/jupyterhub/runbook.md
+
+    [13]: https://grafana.operate-first.cloud/
diff --git a/docs/JH_access.md → docs/setup_environment/JH_access.md b/docs/JH_access.md → docs/setup_environment/JH_access.md
diff --git a/docs/odh_and_opf.md → docs/setup_environment/odh_and_opf.md b/docs/odh_and_opf.md → docs/setup_environment/odh_and_opf.md
diff --git a/docs/remote-storage.md → docs/setup_environment/remote-storage.md b/docs/remote-storage.md → docs/setup_environment/remote-storage.md
diff --git a/docs/setup_environment/thoth.md b/docs/setup_environment/thoth.md
@@ -0,0 +1,10 @@
+### **Set Up AICoE Continuous Integration (CI)**
+
+[AICoE-CI](https://github.com/aicoe/aicoe-ci#getting-started) can aid various aspects of a development workflow such as running pre-commit checks, build checks, triggering pipelines to build images, etc.
+
+For more information on AICoE CI and how to set it up for your project, you can follow the documentation [here](https://github.com/aicoe/aicoe-ci#getting-started).
+
+
+### **Managing Dependencies**
+
+Guidance for managing notebook dependencies can be found in this [video](https://www.youtube.com/watch?v=ifyQ2oSxjnU&list=PL8VBRDTElCWpneB4dBu4u1kHElZVWfAwW&index=4). The repository for our dependency management tool can be found [here](https://github.com/thoth-station/jupyterlab-requirements).
diff --git a/docs/data-visualization-best-practices.md → ...tion/data-visualization-best-practices.md b/docs/data-visualization-best-practices.md → ...tion/data-visualization-best-practices.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		### Creating Automated Model Workflows

		To automate your notebook workflows using Elyra and Kubeflow Pipelines on Open Data Hub, you can refer to the [guide](https://github.com/AICoE/elyra-aidevsecops-tutorial) and view our video [tutorial](https://www.youtube.com/watch?v=iMSOal8wRj4).