Skip to content

Commit 24fde85

Browse files
authored
Merge pull request #64699 from mburke5678/applications-fix-errors
Applications docs fixes during ROSA review
2 parents a9a1bbf + 7a961a3 commit 24fde85

File tree

38 files changed

+311
-165
lines changed

38 files changed

+311
-165
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2131,9 +2131,9 @@ Topics:
21312131
File: odc-creating-applications-using-developer-perspective
21322132
- Name: Creating applications from installed Operators
21332133
File: creating-apps-from-installed-operators
2134-
- Name: Creating applications using the CLI
2134+
- Name: Creating applications by using the CLI
21352135
File: creating-applications-using-cli
2136-
- Name: Viewing application composition using the Topology view
2136+
- Name: Viewing application composition by using the Topology view
21372137
File: odc-viewing-application-composition-using-topology-view
21382138
- Name: Exporting applications
21392139
File: odc-exporting-applications

applications/config-maps.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ Config maps allow you to decouple configuration artifacts from image content to
1010

1111
The following sections define config maps and how to create and use them.
1212

13-
For information on creating config maps, see xref:../nodes/pods/nodes-pods-configmaps.adoc[Creating and using config maps].
14-
1513
include::modules/nodes-pods-configmap-overview.adoc[leveloffset=+1]
1614

15+
.Additional resources
16+
17+
* xref:../nodes/pods/nodes-pods-configmaps.adoc[Creating and using config maps]
18+
1719
[id="nodes-pods-config-maps-consuming-configmap-in-pods"]
1820
== Use cases: Consuming config maps in pods
1921

applications/connecting_applications_to_services/installing-sbo.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ include::modules/op-installing-sbo-operator-using-the-web-console.adoc[leveloffs
2626

2727

2828
== Additional Resources
29+
2930
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
31+

applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ toc::[]
1111

1212
Use the *Topology* view for the following purposes:
1313

14-
** Group multiple components within an application.
14+
* Grouping multiple components within an application.
1515
16-
** Connect components with each other.
16+
* Connecting components with each other.
1717
18-
** Connect multiple resources to services with labels.
18+
* Connecting multiple resources to services with labels.
1919
2020
You can either use a binding or a visual connector to connect components.
2121

@@ -33,5 +33,5 @@ include::modules/odc-visualizing-the-binding-connections-to-resources.adoc[level
3333
[role="_additional-resources"]
3434
[id="additional-resources-odc-connecting-an-application-to-a-service-using-the-developer-perspective"]
3535
== Additional resources
36-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
37-
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
36+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding]
37+
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators]

applications/connecting_applications_to_services/understanding-service-binding-operator.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ include::modules/sbo-api-differences.adoc[leveloffset=+1]
2020
[role="_additional-resources"]
2121
[id="additional-resources_understanding-sbo"]
2222
== Additional resources
23-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
23+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding]

applications/creating_applications/creating-applications-using-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="creating-applications-using-cli"]
3-
= Creating applications using the CLI
3+
= Creating applications by using the CLI
44
include::_attributes/common-attributes.adoc[]
55
:context: creating-applications-using-cli
66

applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="odc-creating-applications-using-developer-perspective"]
3-
= Creating applications using the Developer perspective
3+
= Creating applications by using the Developer perspective
44
include::_attributes/common-attributes.adoc[]
55
:context: odc-creating-applications-using-developer-perspective
66

applications/index.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Using {product-title}, you can create, edit, delete, and manage applications usi
1313

1414
Using projects, you can organize and manage applications in isolation. You can manage the entire project lifecycle, including xref:../applications/projects/working-with-projects.adoc#working-with-projects[creating, viewing, and deleting a project] in {product-title}.
1515

16-
After you create the project, you can xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[grant or revoke access to a project] and xref:../applications/projects/working-with-projects.adoc#odc-customizing-available-cluster-roles-using-developer-perspective_projects[manage cluster roles] for the users using the Developer perspective. You can also xref:../applications/projects/configuring-project-creation.adoc#configuring-project-creation[edit the project configuration resource] while creating a project template that is used for automatic provisioning of new projects.
16+
After you create the project, you can xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[grant or revoke access to a project] and xref:../applications/projects/working-with-projects.adoc#odc-customizing-available-cluster-roles-using-the-web-console_projects[manage cluster roles] for the users using the Developer perspective. You can also xref:../applications/projects/configuring-project-creation.adoc#configuring-project-creation[edit the project configuration resource] while creating a project template that is used for automatic provisioning of new projects.
1717

1818
ifndef::openshift-rosa,openshift-dedicated[]
1919
Using the CLI, you can xref:../applications/projects/creating-project-other-user.adoc#creating-project-other-user[create a project as a different user] by impersonating a request to the {product-title} API. When you make a request to create a new project, the {product-title} uses an endpoint to provision the project according to a customizable template. As a cluster administrator, you can choose to xref:../applications/projects/configuring-project-creation.adoc#disabling-project-self-provisioning_configuring-project-creation[prevent an authenticated user group from self-provisioning new projects].
@@ -28,14 +28,15 @@ endif::openshift-rosa,openshift-dedicated[]
2828
[id="creating-application"]
2929
=== Creating an application
3030

31-
To create applications, you must have created a project or have access to a project with the appropriate roles and permissions. You can create an application by using either xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[the Developer perspective in the web console], xref:../applications/creating_applications/creating-apps-from-installed-operators.adoc#creating-apps-from-installed-operators[installed Operators], or xref:../applications/creating_applications/creating-applications-using-cli.adoc#creating-applications-using-cli[the {product-title} CLI]. You can source the applications to be added to the project from Git, JAR files, devfiles, or the developer catalog.
31+
To create applications, you must have created a project or have access to a project with the appropriate roles and permissions. You can create an application by using either xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[the Developer perspective in the web console], xref:../applications/creating_applications/creating-apps-from-installed-operators.adoc#creating-apps-from-installed-operators[installed Operators], or xref:../applications/creating_applications/creating-applications-using-cli.adoc#creating-applications-using-cli[the {oc-first}]. You can source the applications to be added to the project from Git, JAR files, devfiles, or the developer catalog.
3232

33-
You can also use components that include source or binary code, images, and templates to create an application by using the {product-title} CLI. With the {product-title} web console, you can create an application from an Operator installed by a cluster administrator.
33+
You can also use components that include source or binary code, images, and templates to create an application by using the {oc-first}. With the {product-title} web console, you can create an application from an Operator installed by a cluster administrator.
3434

3535
[id="maintaining-application"]
3636
=== Maintaining an application
3737

38-
After you create the application you can use the web console to xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#odc-monitoring-project-and-application-metrics-using-developer-perspective[monitor your project or application metrics]. You can also xref:../applications/odc-editing-applications.adoc#odc-editing-applications[edit] or xref:../applications/odc-deleting-applications.adoc#odc-deleting-applications[delete] the application using the web console.
38+
After you create the application, you can use the web console to xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#odc-monitoring-project-and-application-metrics-using-developer-perspective[monitor your project or application metrics]. You can also xref:../applications/odc-editing-applications.adoc#odc-editing-applications[edit] or xref:../applications/odc-deleting-applications.adoc#odc-deleting-applications[delete] the application using the web console.
39+
3940
When the application is running, not all applications resources are used. As a cluster administrator, you can choose to xref:../applications/idling-applications.adoc#idling-applications[idle these scalable resources] to reduce resource consumption.
4041

4142
[id="connecting-application"]

applications/odc-viewing-application-composition-using-topology-view.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="odc-viewing-application-composition-using-topology-view"]
3-
= Viewing application composition using the Topology view
3+
= Viewing application composition by using the Topology view
44
include::_attributes/common-attributes.adoc[]
55
:context: viewing-application-composition-using-topology-view
66

applications/projects/working-with-projects.adoc

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,53 @@ In {product-title} clusters that use the Customer Cloud Subscription (CCS) model
3737
====
3838
endif::openshift-dedicated[]
3939

40-
include::modules/creating-a-project-using-the-web-console.adoc[leveloffset=+1]
40+
[id="working-with-projects-create-project"]
41+
== Creating a project
4142

42-
include::modules/odc-creating-projects-using-developer-perspective.adoc[leveloffset=+1]
43+
You can use the {product-title} web console or the {oc-first} to create a project in your cluster.
4344

44-
include::modules/creating-a-project-using-the-CLI.adoc[leveloffset=+1]
45+
include::modules/creating-a-project-using-the-web-console.adoc[leveloffset=+2]
4546

46-
include::modules/viewing-a-project-using-the-web-console.adoc[leveloffset=+1]
47+
// include modules/odc-creating-projects-using-developer-perspective.adoc[leveloffset=+2]
4748

48-
include::modules/viewing-a-project-using-the-CLI.adoc[leveloffset=+1]
49+
.Additional resources
50+
51+
* xref:../../applications/projects/working-with-projects.adoc#odc-customizing-available-cluster-roles-using-the-web-console_projects[Customizing the available cluster roles using the web console]
52+
53+
include::modules/creating-a-project-using-the-CLI.adoc[leveloffset=+2]
54+
55+
[id="working-with-projects-viewing-project"]
56+
== Viewing a project
57+
58+
You can use the {product-title} web console or the {oc-first} to view a project in your cluster.
59+
60+
include::modules/viewing-a-project-using-the-web-console.adoc[leveloffset=+2]
61+
62+
include::modules/viewing-a-project-using-the-CLI.adoc[leveloffset=+2]
4963

5064
include::modules/odc-providing-project-permissions-using-developer-perspective.adoc[leveloffset=+1]
5165

52-
include::modules/odc-customizing-available-cluster-roles-using-developer-perspective.adoc[leveloffset=+1]
66+
include::modules/odc-customizing-available-cluster-roles-using-the-web-console.adoc[leveloffset=+1]
5367

5468
include::modules/adding-to-a-project.adoc[leveloffset=+1]
5569

56-
include::modules/checking-project-status-using-the-web-console.adoc[leveloffset=+1]
70+
[id="working-with-projects-viewing-project-status"]
71+
== Checking the project status
72+
73+
You can use the {product-title} web console or the {oc-first} to view the status of your project.
74+
75+
include::modules/checking-project-status-using-the-web-console.adoc[leveloffset=+2]
76+
77+
include::modules/checking-project-status-using-the-CLI.adoc[leveloffset=+2]
78+
79+
// The following text comes from deleting-a-project-using-the-CLI.adoc
80+
[id="working-with-projects-deleting-project"]
81+
== Deleting a project
82+
83+
You can use the {product-title} web console or the {oc-first} to delete a project.
5784

58-
include::modules/checking-project-status-using-the-CLI.adoc[leveloffset=+1]
85+
When you delete a project, the server updates the project status to *Terminating* from *Active*. Then, the server clears all content from a project that is in the *Terminating* state before finally removing the project. While a project is in *Terminating* status, you cannot add new content to the project. Projects can be deleted from the CLI or the web console.
5986

60-
include::modules/deleting-a-project-using-the-web-console.adoc[leveloffset=+1]
87+
include::modules/deleting-a-project-using-the-web-console.adoc[leveloffset=+2]
6188

62-
include::modules/deleting-a-project-using-the-CLI.adoc[leveloffset=+1]
89+
include::modules/deleting-a-project-using-the-CLI.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)