diff --git a/_toc.yml b/_toc.yml index 34861e2..6da31ce 100644 --- 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 new file mode 100644 index 0000000..eb3c7d6 --- /dev/null +++ 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). \ No newline at end of file diff --git a/docs/automating-via-argo-blog.adoc b/docs/develop_collaborate/automating-via-argo-blog.adoc similarity index 100% rename from docs/automating-via-argo-blog.adoc rename to docs/develop_collaborate/automating-via-argo-blog.adoc diff --git a/docs/create_and_deploy_jh_image.md b/docs/develop_collaborate/create_and_deploy_jh_image.md similarity index 100% rename from docs/create_and_deploy_jh_image.md rename to docs/develop_collaborate/create_and_deploy_jh_image.md diff --git a/docs/develop_collaborate/meteorize.md b/docs/develop_collaborate/meteorize.md new file mode 100644 index 0000000..d049453 --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/thoth-tools.md b/docs/develop_collaborate/thoth-tools.md similarity index 100% rename from docs/thoth-tools.md rename to docs/develop_collaborate/thoth-tools.md diff --git a/docs/aiops-projects.md b/docs/project_structure/aiops-projects.md similarity index 100% rename from docs/aiops-projects.md rename to docs/project_structure/aiops-projects.md diff --git a/docs/boards-and-issues.md b/docs/project_structure/boards-and-issues.md similarity index 100% rename from docs/boards-and-issues.md rename to docs/project_structure/boards-and-issues.md diff --git a/docs/data-science-workflow-blog.adoc b/docs/project_structure/data-science-workflow-blog.adoc similarity index 100% rename from docs/data-science-workflow-blog.adoc rename to docs/project_structure/data-science-workflow-blog.adoc diff --git a/docs/getting-started.md b/docs/project_structure/getting-started.md similarity index 100% rename from docs/getting-started.md rename to docs/project_structure/getting-started.md diff --git a/docs/guidelines-for-reviewing-datascience-code.md b/docs/project_structure/guidelines-for-reviewing-datascience-code.md similarity index 100% rename from docs/guidelines-for-reviewing-datascience-code.md rename to docs/project_structure/guidelines-for-reviewing-datascience-code.md diff --git a/docs/how-to-contribute.md b/docs/project_structure/how-to-contribute.md similarity index 100% rename from docs/how-to-contribute.md rename to docs/project_structure/how-to-contribute.md diff --git a/docs/project-document-template.md b/docs/project_structure/project-document-template.md similarity index 100% rename from docs/project-document-template.md rename to docs/project_structure/project-document-template.md diff --git a/docs/project-structure.md b/docs/project_structure/project-structure.md similarity index 100% rename from docs/project-structure.md rename to docs/project_structure/project-structure.md diff --git a/docs/deploy-models-using-seldon.md b/docs/serving_monitoring/deploy-models-using-seldon.md similarity index 100% rename from docs/deploy-models-using-seldon.md rename to docs/serving_monitoring/deploy-models-using-seldon.md diff --git a/docs/serving_monitoring/monitor-jh.md b/docs/serving_monitoring/monitor-jh.md new file mode 100644 index 0000000..2cc8ce3 --- /dev/null +++ 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/ \ No newline at end of file diff --git a/docs/JH_access.md b/docs/setup_environment/JH_access.md similarity index 100% rename from docs/JH_access.md rename to docs/setup_environment/JH_access.md diff --git a/docs/odh_and_opf.md b/docs/setup_environment/odh_and_opf.md similarity index 100% rename from docs/odh_and_opf.md rename to docs/setup_environment/odh_and_opf.md diff --git a/docs/remote-storage.md b/docs/setup_environment/remote-storage.md similarity index 100% rename from docs/remote-storage.md rename to docs/setup_environment/remote-storage.md diff --git a/docs/setup_environment/thoth.md b/docs/setup_environment/thoth.md new file mode 100644 index 0000000..05a63f4 --- /dev/null +++ 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). \ No newline at end of file diff --git a/docs/data-visualization-best-practices.md b/docs/visualization/data-visualization-best-practices.md similarity index 100% rename from docs/data-visualization-best-practices.md rename to docs/visualization/data-visualization-best-practices.md