[RHDEVDOCS-2332] - Documentation of using the Developer Catalog by rishumehra · Pull Request #29275 · openshift/openshift-docs

rishumehra · 2021-02-09T07:40:38Z

[RHDEVDOCS-2332] - Documentation of using the Developer Catalog

For Openshift 4.7

JIRA task: https://issues.redhat.com/browse/RHDEVDOCS-2332

netlify · 2021-02-09T07:42:42Z

Deploy preview for osdocs ready!

Built with commit 73eb34d

https://deploy-preview-29275--osdocs.netlify.app

Preeticp · 2021-02-09T13:12:26Z

The Developer Catalog...
Suggest: The Developer Catalog contains a collection of application components, services, event sources, or source-to-image builders that you can add to your project.

Thanks for the suggestion. Will incorporate this.

Preeticp · 2021-02-09T13:13:35Z

and then click on MariaDB ...

Preeticp · 2021-02-09T13:21:27Z

to the application group containing the Node.Js component;

Done, edited the sentence as suggested.

Preeticp · 2021-02-09T13:36:11Z

s/app.kubernetes.io/part-of=myapp/app.kubernetes.io/part-of=<application-name>

Will change the application name.

Preeticp · 2021-02-09T13:37:48Z

...you can also add a component in the Topology view to an application...

rishumehra

@Preeticp Thanks for your comments and review. Will make the changes and push a new commit.

rishumehra · 2021-02-09T13:57:07Z

Done, edited the sentence as suggested.

rishumehra · 2021-02-09T13:57:32Z

Will change the application name.

rishumehra · 2021-02-09T13:57:42Z

rishumehra · 2021-02-09T13:58:11Z

Thanks for the suggestion. Will incorporate this.

rishumehra · 2021-02-09T13:58:19Z

rishumehra · 2021-02-09T14:03:17Z

@Preeticp pushed a new commit with the changes based on your earlier suggestions. Kindly have a look.

Preeticp · 2021-02-09T17:24:23Z

/lgtm

gajanan-more · 2021-02-10T07:26:54Z

Suggested change

.. In the *Developer* perspective, navigate to the *+Add* view and select the *Database* option to see the *Developer Catalog*, which has multiple options that you can add as components or services to your application.

.. In the *Developer* perspective, navigate to the *+Add* page and select the *Database* option to see the *Developer Catalog*, which has multiple options that you can add as components or services to your application.

When user clicks on Database card on +Add page, it will open the Developer Catalog page with Database options. In above sentence, it seems that you have added description of Developer Catalog page instead it should what user will see when he/she clicks on Database card on Add page. WDYT about updating above sentence? @Preeticp @rishumehra

@gajanan-more the change from view to page, if done needs to be uniform across the OCP doc set. If required we will pick that change up through another PR.
Suggest similar wording as we have in the other module:
. In the Developer perspective, navigate to the +Add page and select the Database option to view all the available services in the Developer Catalog.
. Select Databases to list all the database services, and then click on the MariaDB option to see the details for the service.
Does this make it more clear?

Option 1:
. In the Developer perspective, navigate to the +Add page and select the From Catalog option to view all the available services in the Developer Catalog.
. Select Databases to list all the database services, and then click on the MariaDB option to see the details for the service.

Option 2:
. In the Developer perspective, navigate to the +Add page and select the Database option to view all the available database services present in the Developer Catalog under Database.
. Select MariaDB option to see the details for the service.

WDYT @Preeticp

@gajanan-more option 1 seems perfect.

Option 1 seems fine to me also. Will incorporate that in the new commit.

gajanan-more · 2021-02-10T07:30:02Z

User will automatically redirected to Topology page and doesn't need to click anywhere.

So should I drop this bullet point or rephrase it with the automatic redirection.

gajanan-more · 2021-02-10T07:32:56Z

This is not required.

Will drop in this in the new commit.

rishumehra

@gajanan-more @Preeticp Checked all the comments and replied to them also. Will make the changes in the new commit.

rishumehra · 2021-02-10T13:39:49Z

Option 1 seems fine to me also. Will incorporate that in the new commit.

rishumehra · 2021-02-10T13:40:37Z

So should I drop this bullet point or rephrase it with the automatic redirection.

rishumehra · 2021-02-10T13:40:54Z

Will drop in this in the new commit.

gajanan-more

/lgtm

gajanan-more · 2021-02-10T14:01:15Z

openshift-ci-robot · 2021-02-10T14:48:06Z

New changes are detected. LGTM label has been removed.

kalexand-rh · 2021-02-10T15:50:05Z

Suggested change

. Create and deploy the MariaDB service to your project as follows:

. Create and deploy the MariaDB service to your project:

kalexand-rh · 2021-02-10T15:50:21Z

Suggested change

.. In the *Developer* perspective, navigate to the *+Add* view and select the *From Catalog* option to view all of the available services in the *Developer Catalog*.

.. In the *Developer* perspective, navigate to the *+Add* view and select the *From Catalog* option to view all available services in the *Developer Catalog*.

kalexand-rh · 2021-02-10T15:51:30Z

Suggested change

.. Select *Databases* to list all the database services, and then click on the *MariaDB* option to see the details for the service.

.. Select *Databases* to list all the database services and then click *MariaDB* option to see the details for the service.

🚫 click on verb
Do not use. Use "click" instead to refer to the action of selecting something on a graphical interface.

Please be consistent about using or not using the comma between your clauses.

kalexand-rh · 2021-02-10T16:24:11Z

This sequence doesn't follow the guidance in the IBM Style Guide for keyboard shortcuts. I think that

Suggested change

. To add the MariaDB service to the existing application group, kbd:[Shift]+ dragging the *mariadb* pod to the application group containing the Node.Js component; the MariaDB service is added to the existing application group.

. To add the MariaDB service to the existing application group, press kbd:[Shift]+ and drag the *mariadb* pod to the application group that contains the Node.Js component. The MariaDB service is added to the existing application group.

kalexand-rh · 2021-02-10T16:25:11Z

Suggested change

. Click on the MariaDB service node to see the label `app.kubernetes.io/part-of=<application-name>` added to the *Labels* section in the *Overview* Panel. kbd:[Shift]+ dragging a component and adding it to an application group automatically adds the required labels to the component.

. Click the MariaDB service node and confirm that the `app.kubernetes.io/part-of=<application-name>`label is in the *Labels* section in the *Overview* Panel. Adding a component to an application group automatically adds the required labels to the component.

kalexand-rh · 2021-02-10T16:30:22Z

Suggested change

.Procedure

To add a *MariaDB* database service from the Developer Catalog:

kalexand-rh · 2021-02-10T16:30:27Z

Suggested change

The following procedure shows you an example of how to add a *MariaDB* database service from the Developer Catalog.

kalexand-rh · 2021-02-10T16:34:41Z

Suggested change

. In the *Developer* perspective, navigate to the *+Add -> From Catalog* to view all the available services in the *Developer Catalog*.

. In the *Developer* perspective, navigate to the *+Add* -> *From Catalog* to view all the available services in the *Developer Catalog*.

Each menu item needs to be enclosed in asterisks.

kalexand-rh · 2021-02-10T16:35:00Z

Suggested change

. Under *All Items* select the kind of service or the component you need to add to your project. For this example, select *Databases* to list all the database services and then click on *MariaDB* to see the details for the service.

. Under *All Items*, select the kind of service or the component you need to add to your project. For this example, select *Databases* to list all the database services and then click *MariaDB* to see the details for the service.

kalexand-rh · 2021-02-10T16:35:39Z

I don't think you need either of these screenshots. They don't add significant value and require maintenance.

…w changes in an existing document.

kalexand-rh · 2021-02-10T19:28:14Z

/cherrypick enterprise-4.7

openshift-cherrypick-robot · 2021-02-10T19:28:55Z

@kalexand-rh: new pull request created: #29388

Details

In response to this:

/cherrypick enterprise-4.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-cherrypick-robot · 2021-02-10T20:07:04Z

@kalexand-rh: new pull request could not be created: failed to create pull request against openshift/openshift-docs#openshift-cherrypick-robot:cherry-pick-29275-to-enterprise-4.7 from enterprise-4.7: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.7 and openshift-cherrypick-robot:cherry-pick-29275-to-enterprise-4.7"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

Details

In response to this:

/cherrypick enterprise-4.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 9, 2021

Preeticp reviewed Feb 9, 2021

View reviewed changes

rishumehra commented Feb 9, 2021

View reviewed changes

openshift-ci-robot assigned Preeticp Feb 9, 2021

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 9, 2021

Preeticp removed their assignment Feb 10, 2021

gajanan-more suggested changes Feb 10, 2021

View reviewed changes

rishumehra commented Feb 10, 2021

View reviewed changes

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 10, 2021

gajanan-more approved these changes Feb 10, 2021

View reviewed changes

Comment thread modules/odc-grouping-multiple-components.adoc Outdated

Copy link
Copy Markdown

gajanan-more Feb 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

openshift-ci-robot assigned gajanan-more Feb 10, 2021

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 10, 2021

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 10, 2021

kalexand-rh reviewed Feb 10, 2021

View reviewed changes

kalexand-rh added branch/enterprise-4.7 peer-review-done Signifies that the peer review team has reviewed this PR labels Feb 10, 2021

kalexand-rh added this to the Future Release milestone Feb 10, 2021

Documentation of using the Developer Catalog with a new module and fe…

73eb34d

…w changes in an existing document.

kalexand-rh merged commit 9c6a78b into openshift:master Feb 10, 2021

openshift-cherrypick-robot mentioned this pull request Feb 10, 2021

[enterprise-4.7] [RHDEVDOCS-2332] - Documentation of using the Developer Catalog #29388

Merged

kalexand-rh added the dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs label Feb 10, 2021

vikram-redhat modified the milestones: Future Release, OCP 4.7 GA Feb 24, 2021

	.. In the Developer perspective, navigate to the +Add view and select the Database option to see the Developer Catalog, which has multiple options that you can add as components or services to your application.
	.. In the Developer perspective, navigate to the +Add page and select the Database option to see the Developer Catalog, which has multiple options that you can add as components or services to your application.

	. Create and deploy the MariaDB service to your project as follows:
	. Create and deploy the MariaDB service to your project:

	.. Select Databases to list all the database services, and then click on the MariaDB option to see the details for the service.
	.. Select Databases to list all the database services and then click MariaDB option to see the details for the service.

	. To add the MariaDB service to the existing application group, kbd:[Shift]+ dragging the mariadb pod to the application group containing the Node.Js component; the MariaDB service is added to the existing application group.
	. To add the MariaDB service to the existing application group, press kbd:[Shift]+ and drag the mariadb pod to the application group that contains the Node.Js component. The MariaDB service is added to the existing application group.

	. Click on the MariaDB service node to see the label `app.kubernetes.io/part-of=<application-name>` added to the Labels section in the Overview Panel. kbd:[Shift]+ dragging a component and adding it to an application group automatically adds the required labels to the component.
	. Click the MariaDB service node and confirm that the `app.kubernetes.io/part-of=<application-name>`label is in the Labels section in the Overview Panel. Adding a component to an application group automatically adds the required labels to the component.



	.Procedure

	To add a MariaDB database service from the Developer Catalog:

	. In the Developer perspective, navigate to the +Add -> From Catalog to view all the available services in the Developer Catalog.
	. In the Developer perspective, navigate to the +Add -> From Catalog to view all the available services in the Developer Catalog.

	. Under All Items select the kind of service or the component you need to add to your project. For this example, select Databases to list all the database services and then click on MariaDB to see the details for the service.
	. Under All Items, select the kind of service or the component you need to add to your project. For this example, select Databases to list all the database services and then click MariaDB to see the details for the service.

Conversation

rishumehra commented Feb 9, 2021

Uh oh!

netlify Bot commented Feb 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rishumehra left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rishumehra commented Feb 9, 2021

Uh oh!

Preeticp commented Feb 9, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rishumehra left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gajanan-more left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify Bot commented Feb 9, 2021 •

edited

Loading

rishumehra left a comment •

edited

Loading