odh-7074 new Managing connected applications guide

assemblies/collaborating-on-notebooks-using-git.adoc → assemblies/collaborating-on-notebooks-by-using-git.adoc

@@ -5,8 +5,8 @@ ifdef::context[:parent-context: {context}]
 
 :context: git-collab
 
-[id="collaborating-on-notebooks-using-git_{context}"]
-= Collaborating on notebooks using Git
+[id="collaborating-on-notebooks-by-using-git_{context}"]
+= Collaborating on notebooks by using Git
 
 [role='_abstract']
 If your notebooks or other files are stored in Git version control, you can import them from a Git repository onto your notebook server to work with them in JupyterLab. When you are ready, you can push your changes back to the Git repository so that others can review or use your models.

assemblies/creating-and-importing-notebooks.adoc

@@ -30,7 +30,7 @@ include::modules/uploading-an-existing-notebook-file-from-a-git-repository-using
 ifndef::upstream[]
 [role='_additional-resources']
 == Additional resources
-* link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/collaborating-on-notebooks-using-git_git-collab[Collaborating on notebooks using Git]
+* link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/collaborating-on-notebooks-by-using-git_git-collab[Collaborating on notebooks by using Git]
 endif::[]
 
 ifdef::parent-context[:context: {parent-context}]

assemblies/enabling-removing-connected-applications.adoc

@@ -0,0 +1,23 @@
+:_module-type: ASSEMBLY
+
+ifdef::context[:parent-context: {context}]
+
+[id="enabling-removing-connected-applications"]
+= Enabling and removing connected applications
+:upstream:
+//:preview:
+
+ifdef::preview[]
+include::../_artifacts/document-attributes-global.adoc[]
+endif::preview[]
+
+You can extend {productname-long} capabilities by connecting to a wide range of open source and third-party applications, such as Starburst, Anaconda, and IBM.
+
+You can also remove unused applications from your {productname-short} dashboard so that you can focus on the applications that you are most likely to use. 
+
+include::modules/enabling-applications-connected.adoc[leveloffset=+1]
+
+include::modules/removing-disabled-applications.adoc[leveloffset=+1]
+
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

assemblies/using-the-jupyter-application.adoc

@@ -0,0 +1,44 @@
+:_module-type: ASSEMBLY
+
+ifdef::context[:parent-context: {context}]
+
+[id="using-the-jupyter-application"]
+= Using the Jupyter application
+:upstream:
+//:preview:
+
+ifdef::preview[]
+include::../_artifacts/document-attributes-global.adoc[]
+endif::preview[]
+
+:context: jupyterapp
+//for Jupyter tile
+//other context that uses these files is jupyterwb for workbench
+
+== Using the Jupyter application
+{productname-long} provides access to Jupyter as an enabled application for situations where, for example, you do not want users to have their own data science projects or you want to open a notebook that was developed outside of {productname-short} and has no dependencies on other environments. 
+
+ifndef::upstream[]
+Note that the preferred way to access Jupyter on {productname-short} is through a data science project, as described in link:{rhoaidocshome}{default-format-url}/working_on_data_science_projects/working-on-data-science-projects_nb-server#creating-a-project-workbench_nb-server[Creating a workbench]. The advantages to using an {productname-short} data science project and creating a workbench that includes Jupyter, is that your project organizes your data science work in one place and adds functionality such as data connections so that you can access data and save your models and pipelines for automating your ML workflow.
+endif::[]
+ifdef::upstream[]
+Note that the preferred way to access Jupyter on {productname-short} is through a data science project, as described in link:{odhdocshome}/working_on_data_science_projects/#creating_a_project_workbench[Creating a workbench]. The advantages to using an {productname-short} data science project and creating a workbench that includes Jupyter, is that your project organizes your data science work in one place and adds functionality such as data connections so that you can access data and save your models and pipelines for automating your ML workflow.
+endif::[]
+
+
+include::assemblies/creating-and-importing-notebooks.adoc[leveloffset=+1]
+
+
+include::assemblies/collaborating-on-notebooks-by-using-git.adoc[leveloffset=+1]
+
+== Managing Python packages
+
+include::modules/viewing-python-packages-installed-on-your-notebook-server.adoc[leveloffset=+2]
+
+include::modules/installing-python-packages-on-your-notebook-server.adoc[leveloffset=+2]
+
+include::modules/troubleshooting-common-problems-in-jupyter-for-users.adoc[leveloffset=+1]
+
+
+ifdef::parent-context[:context: {parent-context}]
+ifndef::parent-context[:!context:]

getting-started-with-open-data-hub.adoc

@@ -25,7 +25,7 @@ include::modules/creating-a-data-science-project.adoc[leveloffset=+1]
 
 include::modules/creating-a-project-workbench.adoc[leveloffset=+1]
 
-include::modules/launching-jupyter-and-starting-a-notebook-server.adoc[leveloffset=+2]
+include::modules/starting-a-jupyter-notebook-server.adoc[leveloffset=+2]
 
 include::modules/options-for-notebook-server-environments.adoc[leveloffset=+2]
 
@@ -35,11 +35,11 @@ include::modules/accessing-tutorials.adoc[leveloffset=+2]
 
 include::modules/configuring-your-ide.adoc[leveloffset=+1]
 
-include::modules/enabling-services-connected-to-open-data-hub.adoc[leveloffset=+1]
+include::modules/enabling-applications-connected.adoc[leveloffset=+1]
 
 include::modules/disabling-applications-connected.adoc[leveloffset=+1]
 
-include::modules/removing-disabled-applications-from-open-data-hub.adoc[leveloffset=+2]
+include::modules/removing-disabled-applications.adoc[leveloffset=+2]
 
 include::assemblies/support-requirements-and-limitations.adoc[leveloffset=+1]
 

modules/accessing-notebook-servers-owned-by-other-users.adoc

@@ -11,19 +11,19 @@ Administrators can access notebook servers that are owned by other users to corr
 ifdef::upstream[]
 * You are part of the {openshift-platform} administrator group which requires  the `cluster-admin` role on {openshift-platform}. For more information, see link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-latest-version}/html/authentication_and_authorization/using-rbac#creating-cluster-admin_using-rbac[Creating a cluster admin]. 
 
-* You have launched the Jupyter application, as described in link:{odhdocshome}/getting-started-with-open-data-hub/#launching-jupyter-and-starting-a-notebook-server_get-started[Launching Jupyter and starting a notebook server].
+* You have launched the Jupyter application, as described in link:{odhdocshome}/getting-started-with-open-data-hub/#starting-a-jupyter-notebook-server_get-started[Starting a Jupyter notebook server].
 endif::[]
 
 ifdef::self-managed[]
 * You are part of the {openshift-platform} administrator group. For more information, see link:{rhoaidocshome}{default-format-url}/installing_and_uninstalling_{url-productname-short}/installing-and-deploying-openshift-ai_install#adding-administrative-users-for-{openshift-platform-url}_install[Adding administrative users for {openshift-platform}].
 
-* You have launched the Jupyter application, as described in link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#launching-jupyter-and-starting-a-notebook-server_get-started[Launching Jupyter and starting a notebook server].
+* You have launched the Jupyter application, as described in link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#starting-a-jupyter-notebook-server_get-started[Starting a Jupyter notebook server].
 endif::[]
 
 ifdef::cloud-service[]
 * You are part of the OpenShift Dedicated or Red Hat OpenShift Service on AWS (ROSA) administrator group. For more information, see link:{rhoaidocshome}{default-format-url}/installing_and_uninstalling_{url-productname-short}/installing-and-deploying-openshift-ai_install#adding-administrative-users-in-openshift_install[Adding administrative users].
 
-* You have launched the Jupyter application, as described in link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#launching-jupyter-and-starting-a-notebook-server_get-started[Launching Jupyter and starting a notebook server].
+* You have launched the Jupyter application, as described in link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#starting-a-jupyter-notebook-server_get-started[Starting a Jupyter notebook server].
 endif::[]
 
 * The notebook server that you want to access is running.

modules/creating-a-new-notebook.adoc

@@ -7,11 +7,9 @@
 [role='_abstract']
 You can create a new Jupyter notebook from an existing notebook container image to access its resources and properties. The *Notebook server control panel* contains a list of available container images that you can run as a single-user notebook server.
 
-// Reference: https://docs.google.com/document/d/1TFszdhIkxXbb7Kc1OirASAlaBkmINYmTtdSyaoHIbZI/edit
-
 .Prerequisites
 * Ensure that you have logged in to {productname-long}.
-* Ensure that you have launched your notebook server and logged in to Jupyter.
+* Ensure that you have launched your notebook server and logged in to JupyterLab.
 * The notebook image exists in a registry, image stream, and is accessible.
 
 .Procedure

modules/disabling-applications-connected.adoc

@@ -8,7 +8,7 @@ You can disable applications and components so that they do not appear on the {p
 
 Disabling unused applications allows your data scientists to manually remove these application tiles from their {productname-short} dashboard so that they can focus on the applications that they are most likely to use.
 ifndef::upstream[]
-See link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/disabling-applications_get-started#removing-disabled-applications_get-started[Removing disabled applications from {productname-short}] for more information about manually removing application tiles.
+See link:{rhoaidocshome}{default-format-url}/working-with-connected-applications/removing-disabled-applications_connected-apps[Removing disabled applications from the dashboard] for more information about manually removing application tiles.
 endif::[]
 
 [IMPORTANT]

modules/enabling-applications-connected.adoc

@@ -0,0 +1,58 @@
+:_module-type: PROCEDURE
+
+[id='enabling-applications-connected_{context}']
+= Enabling applications that are connected to {productname-short}
+
+[role='_abstract']
+You must enable SaaS-based applications, such as Anaconda Professional Edition, before using them with {productname-long}. On-cluster applications are enabled automatically.
+
+Typically, you can install, or enable applications connected to {productname-short} using one of the following methods:
+
+* Enabling the application from the *Explore* page on the {productname-short} dashboard, as documented in the following procedure.
+* Installing the Operator for the application from OperatorHub. OperatorHub is a web console for cluster administrators to discover and select Operators to install on their cluster. It is deployed by default in {openshift-platform} (link:https://access.redhat.com/documentation/en-us/openshift_container_platform/{ocp-latest-version}/html/operators/administrator-tasks#olm-installing-from-operatorhub-using-web-console_olm-adding-operators-to-a-cluster[Installing from OperatorHub using the web console]).
++
+ifndef::upstream[]
+[NOTE]
+====
+Deployments containing Operators installed from OperatorHub may not be fully supported by {org-name}.
+====
+endif::[]
+* Installing the Operator for the application from {org-name} Marketplace (link:https://marketplace.redhat.com/en-us/documentation/operators[Install Operators]).
+ifdef::upstream,self-managed[]
+* Installing the application as an {install-package} to your {openshift-platform} cluster (link:https://docs.openshift.com/container-platform/{ocp-latest-version}/operators/admin/olm-adding-operators-to-cluster.html[Adding Operators to a cluster]).
+endif::[]
+ifdef::cloud-service[]
+* Installing the application as an {install-package} to your OpenShift Dedicated (link:https://docs.openshift.com/dedicated/operators/admin/olm-adding-operators-to-cluster.html[Adding Operators to an OpenShift Dedicated cluster]) or ROSA cluster (link:https://docs.openshift.com/rosa/operators/admin/olm-adding-operators-to-cluster.html[Adding Operators to a ROSA cluster]).
+endif::[]
+
+For some applications (such as Jupyter), the API endpoint is available on the tile for the application on the *Enabled* page of {productname-short}. Certain applications cannot be accessed directly from their tiles, for example, OpenVINO and Anaconda provide notebook images for use in Jupyter and do not provide an endpoint link from their tile. Additionally, it may be useful to store these endpoint URLs as environment variables for easy reference in a notebook environment.
+
+Some applications cannot be accessed directly from their tiles. For example, OpenVINO and Anaconda provide notebook images for use in Jupyter and do not provide an endpoint link from their tiles.
+
+Some independent software vendor (ISV) applications must be installed in specific namespaces. In these cases, the tile for the application in the {productname-short} dashboard specifies the required namespace.
+
+To help you get started quickly, you can access the application's learning resources and documentation on the **Resources** page, or on the **Enabled** page by clicking the relevant link on the tile for the application.
+
+.Prerequisites
+* You have logged in to {productname-short}.
+ifdef::upstream,self-managed[]
+* Your administrator has installed or configured the application on your {openshift-platform} cluster.
+endif::[]
+ifdef::cloud-service[]
+* Your administrator has installed or configured the application on your OpenShift cluster.
+endif::[]
+
+.Procedure
+. On the {productname-short} home page, click *Explore*.
+. On the *Explore* page, find the tile for the application that you want to enable.
+. Click *Enable* on the application tile.
+. If prompted, enter the application's service key and then click *Connect*.
+. Click *Enable* to confirm that you want to enable the application.
+
+.Verification
+* The application that you enabled appears on the *Enabled* page.
+* The API endpoint is displayed on the tile for the application on the *Enabled* page.
+
+//[role="_additional-resources"]
+//.Additional resources
+//* TODO or delete

modules/installing-python-packages-on-your-notebook-server.adoc

@@ -12,7 +12,7 @@
 // endif::[]
 
 [role='_abstract']
-You can install Python packages that are not part of the default notebook server image by adding the package and the version to a `requirements.txt` file and then running the `pip install` command in a notebook cell.
+You can install Python packages that are not part of the default notebook server by adding the package and the version to a `requirements.txt` file and then running the `pip install` command in a notebook cell.
 
 ifndef::upstream[]
 NOTE: You can also install packages directly, but {org-name} recommends using a `requirements.txt` file so that the packages stated in the file can be easily re-used across different notebooks. In addition, using a `requirements.txt` file is also useful when using a S2I build to deploy a model.
@@ -22,7 +22,7 @@ NOTE: You can also install packages directly, but using a `requirements.txt` fil
 endif::[]
 
 .Prerequisites
-* Log in to Jupyter and open a notebook.
+* Log in to JupyterLab and open a notebook.
 
 .Procedure
 . Create a new text file using one of the following methods:

modules/logging-in-to-open-data-hub.adoc

@@ -36,8 +36,8 @@ endif::[]
 [role="_additional-resources"]
 .Additional resources
 ifdef::upstream[]
-* link:{odhdocshome}/getting-started-with-open-data-hub/#launching-jupyter-and-starting-a-notebook-server_get-started[Launching Jupyter and starting a notebook server]
+* link:{odhdocshome}/getting-started-with-open-data-hub/#starting-a-jupyter-notebook-server_get-started[Starting a Jupyter notebook server]
 endif::[]
 ifndef::upstream[]
-* link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#launching-jupyter-and-starting-a-notebook-server_get-started[Launching Jupyter and starting a notebook server]
+* link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/creating-a-project-workbench_get-started#starting-a-jupyter-notebook-server_get-started[Starting a Jupyter notebook server]
 endif::[]