Update odo debugging. #28419

yhontyk · 2021-01-07T10:58:44Z

Branch 4.6 and 4.7

openshift-docs-preview-bot · 2021-01-07T11:01:59Z

The preview will be available shortly at:

modules/developer-cli-odo-debugging-an-application.adoc: https://updateOdoDebugging--ocpdocs.netlify.com/openshift-enterprise/latest/modules/developer-cli-odo-debugging-an-application.html

bobfuru

I have a few updates and suggestions.

bobfuru · 2021-01-20T00:47:25Z

modules/developer-cli-odo-debugging-an-application.adoc

@@ -10,11 +10,83 @@ You can debug your application on in `odo` with the `odo debug` command.



Can you fix the typo above this line? "You can debug your application on in..."

bobfuru · 2021-01-20T00:49:58Z

modules/developer-cli-odo-debugging-an-application.adoc

@@ -10,11 +10,83 @@ You can debug your application on in `odo` with the `odo debug` command.

 .Procedure

-. After an application is deployed, start the port forwarding for your component to debug the application:
+. Download the sample application which contains the necessary `debugrun` step within its devfile:


s/which/that

ISG:

Use that, without a comma, to introduce a restrictive clause.

Use which, preceded by a comma, to introduce a nonrestrictive clause.

bobfuru · 2021-01-20T00:53:32Z

modules/developer-cli-odo-debugging-an-application.adoc

+----
+$ odo create nodejs --starter
+----
+


Especially without any introductory text, these output examples should have a title (.Example output):

In addition, prepend the code block for the output with the title .Example output to make it consistently clear across the docs when this is being represented. A lead-in sentence explaining the example output is optional.

See here for details.

bobfuru · 2021-01-20T00:54:22Z

modules/developer-cli-odo-debugging-an-application.adoc

+Please use `odo push` command to create the component with source deployed
+----
+
+. Push the application with the `--debug` flag which is required for all debugging deployments:


s/flag which/flag, which

bobfuru · 2021-01-20T01:01:18Z

modules/developer-cli-odo-debugging-an-application.adoc

+ ✓  Changes successfully pushed to component
+----
+
+NOTE: You can specify a custom debug command by using the `--debug-command="custom-step"` flag.


In the preview build I generated, the NOTE admonitions look fine, but our guidelines are to format as such:

[IMPORTANT] ==== lorem ipsum ====

So it might be worth an update to these instances.

bobfuru · 2021-01-20T01:02:32Z

modules/developer-cli-odo-debugging-an-application.adoc


-. Attach the debugger bundled in your IDE to the component. Instructions vary depending on your IDE.
+. Attach the debugger bundled in your IDE of choice. Instructions vary depending on your IDE, for example link:https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_remote-debugging[VSCode debugging interface].


For clarity:

s/debugger bundled/debugger that is bundled

s/for example/for example:

bobfuru · 2021-01-20T01:06:43Z

The preview will be available shortly at:

modules/developer-cli-odo-debugging-an-application.adoc: https://updateOdoDebugging--ocpdocs.netlify.com/openshift-enterprise/latest/modules/developer-cli-odo-debugging-an-application.html

The preview build didn't work because it was a single module, so it would be good to include a local build hosted on an internal server. I built one locally to check in this case.

Feedback.

yhontyk · 2021-01-20T22:23:46Z

@bobfuru thank you for the review! I've addressed all of the issues.
Apologies for the absence of the preview, I didn't notice. :( To be fair, it worked when I clicked "Back to our site" and it took me to the preview of the main page from which I could access the module itself - https://updateododebugging--ocpdocs.netlify.app/openshift-enterprise/latest/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.html
Could this be a problem of just the URL generated by the bot? In any case, I'll make sure to check the build next time.

bobfuru · 2021-01-20T22:41:22Z

@bobfuru thank you for the review! I've addressed all of the issues.
Apologies for the absence of the preview, I didn't notice. :( To be fair, it worked when I clicked "Back to our site" and it took me to the preview of the main page from which I could access the module itself - https://updateododebugging--ocpdocs.netlify.app/openshift-enterprise/latest/cli_reference/developer_cli_odo/creating_and_deploying_applications_with_odo/debugging-applications-in-odo.html
Could this be a problem of just the URL generated by the bot? In any case, I'll make sure to check the build next time.

Interesting, the link you shared here works for me as well. I should have tried the "back to our site" link before. 😁 I thought we had a limitation with netlify that it wouldn't allow preview builds for single-file modules because they lived outside the context of an assembly. But that seems to not quite be the case ¯_(ツ)_/¯ @vikram-redhat WDYT?

Changes all LGTM, thanks for the updates. I'll merge/CP to 4.6, 4.7.

bobfuru · 2021-01-20T22:41:55Z

/cherrypick enterprise-4.6

bobfuru · 2021-01-20T22:42:00Z

/cherrypick enterprise-4.7

openshift-cherrypick-robot · 2021-01-20T22:42:10Z

@bobfuru: new pull request created: #28726

In response to this:

/cherrypick enterprise-4.6

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-01-20T22:42:13Z

@bobfuru: new pull request created: #28727

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 do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 7, 2021

yhontyk changed the title ~~[WIP] Update odo debugging.~~ Update odo debugging. Jan 19, 2021

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 19, 2021

bobfuru added branch/enterprise-4.6 branch/enterprise-4.7 labels Jan 20, 2021

bobfuru added this to the Next Release milestone Jan 20, 2021

bobfuru reviewed Jan 20, 2021

View reviewed changes

Update debugging.

fc59882

Feedback.

bobfuru added the peer-review-done Signifies that the peer review team has reviewed this PR label Jan 20, 2021

bobfuru merged commit 054dc7c into openshift:master Jan 20, 2021

openshift-cherrypick-robot mentioned this pull request Jan 20, 2021

[enterprise-4.6] Update odo debugging. #28726

Merged

openshift-cherrypick-robot mentioned this pull request Jan 20, 2021

[enterprise-4.7] Update odo debugging. #28727

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update odo debugging. #28419

Update odo debugging. #28419

yhontyk commented Jan 7, 2021

openshift-docs-preview-bot commented Jan 7, 2021

bobfuru left a comment

bobfuru Jan 20, 2021

bobfuru Jan 20, 2021

bobfuru Jan 20, 2021

bobfuru Jan 20, 2021

bobfuru Jan 20, 2021

bobfuru Jan 20, 2021

bobfuru commented Jan 20, 2021

yhontyk commented Jan 20, 2021

bobfuru commented Jan 20, 2021

bobfuru commented Jan 20, 2021 •

edited by openshift-ci-robot

bobfuru commented Jan 20, 2021 •

edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 •

edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 •

edited by openshift-ci-robot

		@@ -10,11 +10,83 @@ You can debug your application on in `odo` with the `odo debug` command.


		. Attach the debugger bundled in your IDE to the component. Instructions vary depending on your IDE.
		. Attach the debugger bundled in your IDE of choice. Instructions vary depending on your IDE, for example link:https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_remote-debugging[VSCode debugging interface].

Update odo debugging. #28419

Update odo debugging. #28419

Conversation

yhontyk commented Jan 7, 2021

openshift-docs-preview-bot commented Jan 7, 2021

bobfuru left a comment

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru Jan 20, 2021

Choose a reason for hiding this comment

bobfuru commented Jan 20, 2021

yhontyk commented Jan 20, 2021

bobfuru commented Jan 20, 2021

bobfuru commented Jan 20, 2021 • edited by openshift-ci-robot

bobfuru commented Jan 20, 2021 • edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 • edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 • edited by openshift-ci-robot

bobfuru commented Jan 20, 2021 •

edited by openshift-ci-robot

bobfuru commented Jan 20, 2021 •

edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 •

edited by openshift-ci-robot

openshift-cherrypick-robot commented Jan 20, 2021 •

edited by openshift-ci-robot