Skip to content

Commit 368c453

Browse files
Yana Hontykkalexand-rh
andcommitted
Restructuing odo docs.
Co-Authored-By: Kathryn Alexander <[email protected]>
1 parent 749d028 commit 368c453

26 files changed

+88
-54
lines changed

_topic_map.yml

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1606,10 +1606,29 @@ Topics:
16061606
Topics:
16071607
- Name: Understanding odo
16081608
File: understanding-odo
1609-
- Name: odo architecture
1610-
File: odo-architecture
16111609
- Name: Installing odo
16121610
File: installing-odo
1611+
- Name: Creating and deploying applications with odo
1612+
Dir: creating_and_deploying_applications_with_odo
1613+
Topics:
1614+
- Name: Working with projects
1615+
File: working-with-projects
1616+
- Name: Creating a single-component application with odo
1617+
File: creating-a-single-component-application-with-odo
1618+
- Name: Creating a multicomponent application with odo
1619+
File: creating-a-multicomponent-application-with-odo
1620+
- Name: Creating an application with a database
1621+
File: creating-an-application-with-a-database
1622+
- Name: Using devfiles in odo
1623+
File: using-devfiles-in-odo
1624+
- Name: Working with storage
1625+
File: working-with-storage
1626+
- Name: Deleting applications
1627+
File: deleting-applications
1628+
- Name: Debugging applications in odo
1629+
File: debugging-applications-in-odo
1630+
- Name: Sample applications
1631+
File: sample-applications
16131632
- Name: Using odo in a restricted environment
16141633
Dir: using_odo_in_a_restricted_environment
16151634
Topics:
@@ -1619,26 +1638,16 @@ Topics:
16191638
File: pushing-the-odo-init-image-to-the-restricted-cluster-registry
16201639
- Name: Creating and deploying a component to the disconnected cluster
16211640
File: creating-and-deploying-a-component-to-the-disconnected-cluster
1622-
- Name: Creating a single-component application with odo
1623-
File: creating-a-single-component-application-with-odo
1624-
- Name: Creating a multicomponent application with odo
1625-
File: creating-a-multicomponent-application-with-odo
1626-
- Name: Creating an application with a database
1627-
File: creating-an-application-with-a-database
1628-
- Name: Using devfiles in odo
1629-
File: using-devfiles-in-odo
1630-
- Name: Using sample applications
1631-
File: using-sample-applications
16321641
- Name: Creating instances of services managed by Operators
16331642
File: creating-instances-of-services-managed-by-operators
1634-
- Name: Debugging applications in odo
1635-
File: debugging-applications-in-odo
16361643
- Name: Managing environment variables in odo
16371644
File: managing-environment-variables-in-odo
16381645
- Name: Configuring the odo CLI
16391646
File: configuring-the-odo-cli
16401647
- Name: odo CLI reference
16411648
File: odo-cli-reference
1649+
- Name: odo architecture
1650+
File: odo-architecture
16421651
- Name: odo release notes
16431652
File: odo-release-notes
16441653
- Name: Helm CLI

cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ the service. If this YAML has placeholder values or sample values, a service can
1515
** 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].
1616
* Install the `{odo-title}` CLI.
1717

18-
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
18+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
1919
include::modules/developer-cli-odo-listing-available-services-from-the-operators-installed-on-the-cluster.adoc[leveloffset=+1]
2020
include::modules/developer-cli-odo-creating-a-service-from-an-operator.adoc[leveloffset=+1]
2121
include::modules/developer-cli-odo-creating-services-from-yaml-files.adoc[leveloffset=+1]

cli_reference/developer_cli_odo/creating-a-multicomponent-application-with-odo.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-multicomponent-application-with-odo.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ toc::[]
99

1010
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.
1111

12-
== Prerequisites
12+
.Prerequisites
1313

1414
* `{odo-title}` is installed.
1515
* 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.
1616
* Maven is installed.
1717

18-
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
18+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
1919

2020
include::modules/developer-cli-odo-deploying-the-back-end-component.adoc[leveloffset=+1]
2121

cli_reference/developer_cli_odo/creating-a-single-component-application-with-odo.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-a-single-component-application-with-odo.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ toc::[]
77

88
With `{odo-title}`, you can create and deploy applications on clusters.
99

10-
== Prerequisites
10+
.Prerequisites
1111

1212
* `{odo-title}` is installed.
1313
* 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.
1414

15-
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
15+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
1616

1717
include::modules/developer-cli-odo-creating-and-deploying-a-nodejs-application-with-odo.adoc[leveloffset=+1]
1818

cli_reference/developer_cli_odo/creating-an-application-with-a-database.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/creating-an-application-with-a-database.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ toc::[]
77

88
This example describes how to deploy and connect a database to a front-end application.
99

10-
== Prerequisites
10+
.Prerequisites
1111

1212
* `{odo-title}` is installed.
1313
* `oc` client is installed.
@@ -19,8 +19,7 @@ This example describes how to deploy and connect a database to a front-end appli
1919
Service Catalog is deprecated on {product-title} 4 and later.
2020
====
2121

22-
23-
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+1]
22+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]
2423

2524
include::modules/developer-cli-odo-deploying-the-front-end-component.adoc[leveloffset=+1]
2625

@@ -29,5 +28,3 @@ include::modules/developer-cli-odo-deploying-a-database-in-interactive-mode.adoc
2928
include::modules/developer-cli-odo-deploying-a-database-manually.adoc[leveloffset=+1]
3029

3130
include::modules/developer-cli-odo-connecting-the-database.adoc[leveloffset=+1]
32-
33-
include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]

cli_reference/developer_cli_odo/debugging-applications-in-odo.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.adoc

File renamed without changes.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[id='deleting-applications']
2+
= Deleting applications
3+
include::modules/developer-cli-odo-attributes.adoc[]
4+
include::modules/common-attributes.adoc[]
5+
:context: deleting-applications
6+
toc::[]
7+
8+
You can delete applications and all components associated with the application in your project.
9+
10+
include::modules/developer-cli-odo-deleting-an-application.adoc[leveloffset=+1]

cli_reference/developer_cli_odo/using-sample-applications.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/sample-applications.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
[id="using-sample-applications"]
2-
= Using sample applications
1+
[id="sample-applications"]
2+
= Sample applications
33
include::modules/developer-cli-odo-attributes.adoc[]
44
include::modules/common-attributes.adoc[]
55
:context: using-sample-applications

cli_reference/developer_cli_odo/using-devfiles-in-odo.adoc renamed to cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/using-devfiles-in-odo.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ include::modules/developer-cli-odo-about-devfiles-in-odo.adoc[leveloffset=+1]
99

1010
== Creating a Java application by using a devfile
1111

12-
== Prerequisites
12+
.Prerequisites
1313

1414
* You have installed `{odo-title}`.
1515
* 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].
1616

17-
include::modules/developer-cli-odo-creating-a-project-in-odo.adoc[leveloffset=+2]
17+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+2]
1818

1919
include::modules/developer-cli-odo-listing-available-devfile-components.adoc[leveloffset=+2]
2020

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[id="working-with-projects"]
2+
= Working with projects
3+
include::modules/developer-cli-odo-attributes.adoc[]
4+
include::modules/common-attributes.adoc[]
5+
:context: working-with-projects
6+
toc::[]
7+
8+
Project keeps your source code, tests, and libraries organized in a separate single unit.
9+
10+
include::modules/developer-cli-odo-creating-a-project.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)