feat(helm): Create Opensearch E2E tutorial for cogstack CE (#65)

Author: alhendrickson

docs/docs/cogstack-ce/tutorial/end-to-end-jupyterhub.md

@@ -13,7 +13,10 @@ By the end, you will have completed an end-to-end user flow:
 !!! tip
     The following tutorial will use your CogStack CE installation and let you run real code against your environment.
 
-    To see a non-interactive version of the tutorial notebook, refer to [the MedCAT Service Tutorial notebook](../../platform/cogstack-ai/medcat-service-tutorial.ipynb).
+    To see a non-interactive version of the tutorial notebook, refer to:
+
+    - [the MedCAT Service Tutorial notebook](../../platform/cogstack-ai/medcat-service-tutorial.ipynb).
+    - [the OpenSearch E2E notebook](./medcat-opensearch-e2e.ipynb).
 
 ## Before you start
 
@@ -46,11 +49,12 @@ Log in with:
 
 After login, JupyterLab opens for your user.
 
-## Step 3: Open the bundled notebook
+## Step 3: Open the bundled notebooks
 
-The chart includes an example notebook:
+The chart includes example notebooks to interact with CogStack CE:
 
 - `medcat-service-tutorial.ipynb`
+- `medcat-opensearch-e2e.ipynb`
 
 You can open it directly:
 
@@ -62,10 +66,11 @@ Or navigate to it in JupyterLab and click to open it.
 
 Run each cell in order from top to bottom.
 
-The notebook demonstrates service calls to:
+The notebooks demonstrates service calls to:
 
 - `medcat-service` at `/api/process` for named entity extraction
 - `anoncat-service` at `/api/process` for de-identification
+- `OpenSearch` for indexing and searching data.
 
 It uses environment variables for service URLs where available, so the default CogStack CE setup should work without edits.
 
@@ -83,13 +88,12 @@ If those outputs appear, you have validated the full end-to-end flow from Jupyte
 
 - If JupyterHub does not load, ensure port-forwarding is running.
 - If notebook requests fail, verify the cluster services are up and re-run:
-
   - `helm get notes <release> | bash`
-- For production deployments, replace dummy authentication with secure auth configuration.
 
+- For production deployments, replace dummy authentication with secure auth configuration.
 
 ## Next Steps
 
 - See the [full deployment documentation](../../platform/deployment/_index.md) for more details on scaling, production security, and advanced configuration options.
 - See full install instructions of the cogstack CE chart[CogStack CE Helm chart (install + customization)](../../platform/deployment/helm/charts/cogstack-ce-helm.md)
-- See further tutorials on medcat on [GitHub](https://github.com/CogStack/cogstack-nlp/tree/79f00cfc204f4ae559b56c8e397bbcaf82d44274/medcat-v2-tutorials)
+- See further tutorials on medcat on [GitHub](https://github.com/CogStack/cogstack-nlp/tree/79f00cfc204f4ae559b56c8e397bbcaf82d44274/medcat-v2-tutorials)

docs/mkdocs.yml

@@ -39,7 +39,8 @@ nav:
           - Overview: cogstack-ce/_index.md
           - Quickstart: cogstack-ce/tutorial/quickstart-installation.md
           - Tutorials:
-              - End To End Tutorial: cogstack-ce/tutorial/end-to-end-jupyterhub.md
+              - Using JupyterHub: cogstack-ce/tutorial/end-to-end-jupyterhub.md
+              - End To End Tutorial: cogstack-ce/tutorial/medcat-opensearch-e2e.ipynb
   - CogStack AI:
       - CogStack AI: cogstack-ai/index.md
       - Natural Language Processing: overview/Natural Language Processing.md

docs/scripts/copy_files_from_repo.py

@@ -24,7 +24,11 @@
     {
         "sourceFilePath": "helm-charts/cogstack-helm-ce/charts/jupyterhub/examples/medcat-service-tutorial.ipynb",
         "outputFilePath": "platform/cogstack-ai/medcat-service-tutorial.ipynb",
-    }
+    },
+    {
+        "sourceFilePath": "helm-charts/cogstack-helm-ce/charts/jupyterhub/examples/medcat-opensearch-e2e.ipynb",
+        "outputFilePath": "cogstack-ce/tutorial/medcat-opensearch-e2e.ipynb",
+    },
 ]
 
 
@@ -46,4 +50,3 @@ def main() -> None:
 
 
 main()
-