Merge pull request #26185 from boczkowska/restructure

vikram-redhat · web-flow · commit 63a6d9fade29 · 2020-11-05T18:22:41.000+10:00
Restructure odo docs.
diff --git a/_topic_map.yml b/_topic_map.yml
@@ -1619,10 +1619,29 @@ Topics:
   Topics:
   - Name: Understanding odo
     File: understanding-odo
-  - Name: odo architecture
-    File: odo-architecture
   - Name: Installing odo
     File: installing-odo
+  - Name: Creating and deploying applications with odo
+    Dir: creating_and_deploying_applications_with_odo
+    Topics:
+      - Name: Working with projects
+        File: working-with-projects
+      - Name: Creating a single-component application with odo
+        File: creating-a-single-component-application-with-odo
+      - Name: Creating a multicomponent application with odo
+        File: creating-a-multicomponent-application-with-odo
+      - Name: Creating an application with a database
+        File: creating-an-application-with-a-database  
+      - Name: Using devfiles in odo
+        File: using-devfiles-in-odo
+      - Name: Working with storage
+        File: working-with-storage
+      - Name: Deleting applications
+        File: deleting-applications
+      - Name: Debugging applications in odo
+        File: debugging-applications-in-odo
+      - Name: Sample applications
+        File: sample-applications
   - Name: Using odo in a restricted environment
     Dir: using_odo_in_a_restricted_environment
     Topics:
@@ -1632,26 +1651,16 @@ Topics:
       File: pushing-the-odo-init-image-to-the-restricted-cluster-registry
     - Name: Creating and deploying a component to the disconnected cluster
       File: creating-and-deploying-a-component-to-the-disconnected-cluster
-  - Name: Creating a single-component application with odo
-    File: creating-a-single-component-application-with-odo
-  - Name: Creating a multicomponent application with odo
-    File: creating-a-multicomponent-application-with-odo
-  - Name: Creating an application with a database
-    File: creating-an-application-with-a-database
-  - Name: Using devfiles in odo
-    File: using-devfiles-in-odo
-  - Name: Using sample applications
-    File: using-sample-applications
   - Name: Creating instances of services managed by Operators
     File: creating-instances-of-services-managed-by-operators
-  - Name: Debugging applications in odo
-    File: debugging-applications-in-odo
   - Name: Managing environment variables in odo
     File: managing-environment-variables-in-odo
   - Name: Configuring the odo CLI
     File: configuring-the-odo-cli
   - Name: odo CLI reference
     File: odo-cli-reference
+  - Name: odo architecture
+    File: odo-architecture
   - Name: odo release notes
     File: odo-release-notes
 - Name: Helm CLI
diff --git a/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc b/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc
@@ -15,7 +15,7 @@ the service. If this YAML has placeholder values or sample values, a service can
 ** Note that the configuration of the cluster determines the services available to you. To access the Operator services, a cluster administrator must install the respective Operator on the cluster first. To learn more, see xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-installing-operators-from-operatorhub_olm-adding-operators-to-a-cluster[Adding Operators to the cluster].
 * Install the `{odo-title}` CLI.
 
-include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
 include::modules/developer-cli-odo-listing-available-services-from-the-operators-installed-on-the-cluster.adoc[leveloffset=+1]
 include::modules/developer-cli-odo-creating-a-service-from-an-operator.adoc[leveloffset=+1]
 include::modules/developer-cli-odo-creating-services-from-yaml-files.adoc[leveloffset=+1]
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc
@@ -9,13 +9,13 @@ toc::[]
 
 This example describes how to deploy a multicomponent application - a shooter game. The application consists of a front-end Node.js component and a back-end Java component.
 
-== Prerequisites
+.Prerequisites
 
 * `{odo-title}` is installed.
 * You have a running cluster. Developers can use link:https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[CodeReady Containers (CRC)] to deploy a local cluster quickly.
 * Maven is installed.
 
-include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
 
 include::modules/developer-cli-odo-deploying-the-back-end-component.adoc[leveloffset=+1]
 
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc
@@ -7,12 +7,12 @@ toc::[]
 
 With `{odo-title}`, you can create and deploy applications on  clusters.
 
-== Prerequisites
+.Prerequisites
 
 * `{odo-title}` is installed.
 * You have a running cluster. You can use link:https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[CodeReady Containers (CRC)] to deploy a local cluster quickly.
 
-include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
 
 include::modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc[leveloffset=+1]
 
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
@@ -7,7 +7,7 @@ toc::[]
 
 This example describes how to deploy and connect a database to a front-end application.
 
-== Prerequisites
+.Prerequisites
 
 * `{odo-title}` is installed.
 * `oc` client is installed.
@@ -19,8 +19,7 @@ This example describes how to deploy and connect a database to a front-end appli
 Service Catalog is deprecated on {product-title} 4 and later.
 ====
 
-
-include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
 
 include::modules/developer-cli-odo-deploying-the-front-end-component.adoc[leveloffset=+1]
 
@@ -29,5 +28,3 @@ include::modules/developer-cli-odo-deploying-a-database-in-interactive-mode.adoc
 include::modules/developer-cli-odo-deploying-a-database-manually.adoc[leveloffset=+1]
 
 include::modules/developer-cli-odo-connecting-the-database.adoc[leveloffset=+1]
-
-include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/deleting-applications.adoc
@@ -0,0 +1,10 @@
+[id='deleting-applications']
+= Deleting applications
+include::modules/developer-cli-odo-attributes.adoc[]
+include::modules/common-attributes.adoc[]
+:context: deleting-applications
+toc::[]
+
+You can delete applications and all components associated with the application in your project.
+
+include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc
@@ -1,5 +1,5 @@
-[id="using-sample-applications"]
-= Using sample applications
+[id="sample-applications"]
+= Sample applications
 include::modules/developer-cli-odo-attributes.adoc[]
 include::modules/common-attributes.adoc[]
 :context: using-sample-applications
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc
@@ -9,12 +9,12 @@ include::modules/developer-cli-odo-about-devfiles-in-odo.adoc[leveloffset=+1]
 
 == Creating a Java application by using a devfile
 
-== Prerequisites
+.Prerequisites
 
 * You have installed `{odo-title}`. 
 * You must know your ingress domain cluster name. Contact your cluster administrator if you do not know it. For example, `apps-crc.testing` is the cluster domain name for https://access.redhat.com/documentation/en-us/red_hat_codeready_containers/[Red Hat CodeReady Containers].
 
-include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+2]
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+2]
 
 include::modules/developer-cli-odo-listing-available-devfile-components.adoc[leveloffset=+2]
 
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects.adoc
@@ -0,0 +1,10 @@
+[id="working-with-projects"]
+= Working with projects
+include::modules/developer-cli-odo-attributes.adoc[]
+include::modules/common-attributes.adoc[]
+:context: working-with-projects
+toc::[]
+
+Project keeps your source code, tests, and libraries organized in a separate single unit.
+
+include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
diff --git a/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc b/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc
@@ -0,0 +1,10 @@
+[id='working-with-storage']
+= Working with storage
+include::modules/developer-cli-odo-attributes.adoc[]
+include::modules/common-attributes.adoc[]
+:context: working-with-storage
+toc::[]
+
+Persistent storage keeps data available between restarts of `{odo-title}`.
+
+include::modules/developer-cli-odo-adding-storage-to-the-application-components.adoc[leveloffset=+1]
diff --git a/cli_reference/developer_cli_odo/odo-release-notes.adoc b/cli_reference/developer_cli_odo/odo-release-notes.adoc
@@ -8,16 +8,16 @@ toc::[]
 [id="odo-notable-improvements_{context}"]
 == Notable changes and improvements in `{odo-title}`
 
-* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles]. 
+* `{odo-title}` integration with devfiles is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#creating-a-java-application-by-using-a-devfile[Creating applications by using devfiles]. 
 
 * The default deployment mechanism in `{odo-title}` is the devfile deployment now.
 
-* Added documentation about converting S2I to devfile. See, xref:../../cli_reference/developer_cli_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
+* Added documentation about converting S2I to devfile. See, xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc#converting-an-s2i-component-into-a-devfile-component_creating-applications-by-using-devfiles[Converting an S2I component into a devfile component].
 
 * Added commands to display JSON output for devfile components. 
 
 * `odo debug` is no longer a Technology Preview feature and is now fully supported.
-To learn more, see xref:../../cli_reference/developer_cli_odo/debugging-applications-in-odo.html#debugging-an-application_debugging-applications-in-odo[Debugging applications in odo].
+To learn more, see xref:../../cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.html#debugging-an-application_debugging-applications-in-odo[Debugging applications in odo].
 
 * `{odo-title}` integration with Operators is no longer a Technology Preview feature and is now fully supported. To learn more, see xref:../../cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc[Creating instances of services managed by Operators]. 
 
diff --git a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc
@@ -10,7 +10,7 @@ After you push the `init` image to a cluster with a mirrored registry, you must
 == Prerequisites
 
 * Install `oc` on the client operating system.
-* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux[Install `{odo-title}`] on the client operating system.
+* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux_installing-odo[Install `{odo-title}`] on the client operating system.
 * Access to an restricted cluster with a configured internal registry or a mirror registry.
 * xref:../../../cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc#pushing-the-odo-init-image-to-a-mirror-registry_pushing-the-odo-init-image-to-the-restricted-cluster-registry[Push the `odo` init image to your cluster registry].
 
diff --git a/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc b/cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/pushing-the-odo-init-image-to-the-restricted-cluster-registry.adoc
@@ -10,7 +10,7 @@ Depending on the configuration of your cluster and your operating system you can
 == Prerequisites
 
 * Install `oc` on the client operating system.
-* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux[Install `{odo-title}`] on the client operating system.
+* xref:../../../cli_reference/developer_cli_odo/installing-odo.adoc#installing-odo-on-linux_installing-odo[Install `{odo-title}`] on the client operating system.
 * Access to a restricted cluster with a configured internal registry or a mirror registry.
 
 include::modules/developer-cli-odo-pushing-the-odo-init-image-to-a-mirror-registry.adoc[leveloffset=+1]
diff --git a/modules/developer-cli-odo-adding-storage-to-the-application-components.adoc b/modules/developer-cli-odo-adding-storage-to-the-application-components.adoc
@@ -1,11 +1,11 @@
 // Module included in the following assemblies:
 //
-// *cli_reference/developer_cli_odo/creating-an-application-with-odo.adoc
+// *cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc
+// *cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-storage.adoc
 
 [id="adding-storage-to-the-application-components_{context}"]
 = Adding storage to the application components
 
-Persistent storage keeps data available between restarts of {odo-title}.
 Use the `odo storage` command to add persistent data to your application. Examples of data that must persist include database files, dependencies, and build artifacts, such as a `.m2` Maven directory.
 
 .Procedure
diff --git a/modules/developer-cli-odo-configuring-debugging-parameters.adoc b/modules/developer-cli-odo-configuring-debugging-parameters.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/debugging-applications-in-odo.adoc
+// * cli_reference/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc
 
 [id="configuring-debugging-parameters_{context}"]
 
diff --git a/modules/developer-cli-odo-connecting-the-database.adoc b/modules/developer-cli-odo-connecting-the-database.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * cli_reference/developer_cli_odo/creating-a-multicomponent-application-with-odo.adoc
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
 
 [id="Connecting-the-database-to-the-front-end-application_{context}"]
 = Connecting the database to the front-end application
diff --git a/modules/developer-cli-odo-creating-a-project.adoc b/modules/developer-cli-odo-creating-a-project.adoc
@@ -1,8 +1,9 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/developer_cli_odo/creating-a-single-component-application-with-odo.adoc.adoc
-// * cli_reference/developer_cli_odo/creating-a-multicomponent-application-with-odo.adoc.adoc
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/working-with-projects
 
 [id="creating-a-project_{context}"]
 = Creating a project
diff --git a/modules/developer-cli-odo-debugging-an-application.adoc b/modules/developer-cli-odo-debugging-an-application.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/debugging-applications-in-odo.adoc
+// * cli_reference/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc
 
 [id="debugging-an-application_{context}"]
 
diff --git a/modules/developer-cli-odo-deleting-an-application.adoc b/modules/developer-cli-odo-deleting-an-application.adoc
@@ -1,16 +1,13 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/developer_cli_odo/creating-a-single-component-application-with-odo.adoc
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc
-// * cli_reference/developer_cli_odo/creating-a-multicomponent-application-with-odo.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc
 
 [id="deleting-an-application_{context}"]
 = Deleting an application
 
-[IMPORTANT]
-====
-Deleting an application will delete all components associated with the application.
-====
+Use the `odo app delete` command to delete your application.
 
 .Procedure
 
diff --git a/modules/developer-cli-odo-deploying-a-database-in-interactive-mode.adoc b/modules/developer-cli-odo-deploying-a-database-in-interactive-mode.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
 
 [id="deploying-a-database-in-interactive-mode_{context}"]
 = Deploying a database in interactive mode
diff --git a/modules/developer-cli-odo-deploying-a-database-manually.adoc b/modules/developer-cli-odo-deploying-a-database-manually.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
 
 [id="deploying-a-database-manually_{context}"]
 = Deploying a database manually
diff --git a/modules/developer-cli-odo-deploying-the-front-end-component.adoc b/modules/developer-cli-odo-deploying-the-front-end-component.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * cli_reference/developer_cli_odo/creating-a-multicomponent-application-with-odo.adoc
-// * cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc
+// * cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc
 
 ifeval::["{context}" == "creating-a-multicomponent-application-with-odo"]
 :multi:
diff --git a/modules/developer-cli-odo-installing-odo-on-linux.adoc b/modules/developer-cli-odo-installing-odo-on-linux.adoc
@@ -2,7 +2,7 @@
 //
 // * cli_reference/developer_cli_odo/installing-odo.adoc
 
-[id="installing-odo-on-linux"]
+[id="installing-odo-on-linux_{context}"]
 
 = Installing {odo-title} on Linux
 
diff --git a/modules/developer-cli-odo-installing-odo-on-macos.adoc b/modules/developer-cli-odo-installing-odo-on-macos.adoc
@@ -2,7 +2,7 @@
 //
 // * cli_reference/developer_cli_odo/installing-odo.adoc
 
-[id="installing-odo-on-macos"]
+[id="installing-odo-on-macos_{context}"]
 
 = Installing {odo-title} on macOS
 
diff --git a/modules/developer-cli-odo-installing-odo-on-windows.adoc b/modules/developer-cli-odo-installing-odo-on-windows.adoc
@@ -2,7 +2,7 @@
 //
 // * cli_reference/developer_cli_odo/installing-odo.adoc     
 
-[id="installing-odo-on-windows"]
+[id="installing-odo-on-windows_{context}"]
 
 = Installing {odo-title} on Windows
 
