Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Openshift Do docs #16627

Closed
wants to merge 94 commits into from

Conversation

@boczkowska
Copy link
Contributor

commented Sep 13, 2019

  • branch/enterprise-4.2
  • reviewed and approved by OpenShift Do SMEs

Installation part is not ready, waiting for the developers to finalize changes.

Yana Hontyk
@openshift-docs-preview-bot

This comment has been minimized.

Copy link

commented Sep 20, 2019

The preview will be available shortly at:

boczkowska added 11 commits Sep 23, 2019
@bergerhoffer bergerhoffer self-requested a review Sep 24, 2019
Copy link
Contributor

left a comment

Hi @boczkowska, I've left some feedback - let me know if you have any questions on it.

Also, before this can be merged, the commits will need to be squashed. Thanks!

_topic_map.yml Outdated Show resolved Hide resolved
_topic_map.yml Outdated Show resolved Hide resolved
@cdrage

This comment has been minimized.

Copy link

commented Sep 26, 2019

@boczkowska left a review too. For some reason it didnt submit when I made the comments yesterday. So here it is!

@cdrage

This comment has been minimized.

Copy link

commented Oct 2, 2019

@bergerhoffer @boczkowska

Is there any way to have our own section?

Screenshot from 2019-10-02 09-58-57

I feel as though odo is hidden away and that it's not just CLI reference, it's regarding how odo works, examples, etc.

@bergerhoffer

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

@cdrage I would personally prefer all CLI docs to live under the same section, though we can always revisit this and discuss with @aheslin whether to let each CLI have their own bucket or not.

However, there are two things we can also consider doing:

  1. Once this PR is merged, I was planning on moving the existing oc CLI docs into a similar subfolder as odo, so it would look like the following, which shouldn't make odo so hidden:
  • CLI reference
    • OpenShift CLI (oc)
    • OpenShift Do developer CLI (odo)
  1. We could also consider renaming the "CLI reference" bucket. That was a legacy name brought forward from 3.x docs, but it is true that the docs do contain more than just reference material. I don't have any suggestions off the top of my head, but we could brainstorm some ideas.
@bergerhoffer

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

@aheslin wdyt of renaming the bucket for 4.2? This might be a good time to do so before GA.

My suggestions would be either "CLI tools" or "Command-line interfaces (CLI)" (plural since there are now multiple).

image

image

@bergerhoffer

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

I've opened a PR (#17003) to rename the bucket to "CLI tools" and move the oc docs into their own subdirectory.

@boczkowska Will this PR be ready to merge before OCP 4.2 GA? I was going to wait to merge my PR until this merges so that you don't run into conflicts. But mine needs to get in before GA. Thanks!

@Preeticp

This comment has been minimized.

Copy link
Contributor

commented Oct 10, 2019

@vikram-redhat QE is in the process of verifying it and will give it's feedback by today EOD.

@vikram-redhat

This comment has been minimized.

Copy link
Contributor

commented Oct 10, 2019

Thanks @Preeticp

// * cli_reference/openshift_developer_cli/creating-a-single-component-application-with-odo.adoc

[id='odo-sample-applications']
= Sample applications

This comment has been minimized.

Copy link
@cdrage

cdrage Oct 10, 2019

Just a thought, but shouldn't we actually move this whole section into the "Understanding odo" page, what are your thoughts? The sample applications as well as examples?

This comment has been minimized.

Copy link
@cdrage

This comment has been minimized.

Copy link
@Preeticp

Preeticp Oct 11, 2019

Contributor

@cdrage for a user who has just started using odo, he would first need to understand what odo does, install it, and then create an application. It would not work if user starts off with $ odo create java --git https://github.com/spring-projects/spring-petclinic.git
Thus, I believe the current placement is right.
In case the user prefers examples other than Node.js he can directly jump to the other examples using the TOC right at the top of the page.
Screenshot from 2019-10-11 12-29-50

@amitkrout

This comment has been minimized.

Copy link

commented Oct 11, 2019

@boczkowska I have completed the doc review.

@preethit @kadel As i mentioned above #16627 (comment), IMO the same doc should be available for each 4.2 OpenShift distribution because the cluster web console of all 4.2 distribution displays the availability of command line tools oc and odo. For example in OpenShift online distribution attaching the screenshot for reference.

Screen Shot 2019-10-11 at 11 16 34 AM

@prietyc123

This comment has been minimized.

Copy link

commented Oct 11, 2019

@boczkowska i have reviewed the doc and added my review comments. Please address those comments.

boczkowska added 2 commits Oct 11, 2019
.
@kadel

This comment has been minimized.

Copy link
Member

commented Oct 11, 2019

boczkowska I have completed the doc review.

@preethit @kadel As i mentioned above #16627 (comment), IMO the same doc should be available for each 4.2 OpenShift distribution because the cluster web console of all 4.2 distribution displays the availability of command line tools oc and odo. For example in OpenShift online distribution attaching the screenshot for reference.

Screen Shot 2019-10-11 at 11 16 34 AM

Yes, odo will be available in any 4.2 clusters. So documentation should be also there.

@amitkrout did verify that odo is working with Online and Dedicated as well.

@@ -992,6 +992,24 @@ Topics:
- Name: Administrator CLI commands
File: administrator-cli-commands
Distros: openshift-enterprise,openshift-origin
- Name: OpenShift Do developer CLI (odo)
Dir: openshift_developer_cli
Distros: openshift-enterprise

This comment has been minimized.

Copy link
@Preeticp

Preeticp Oct 11, 2019

Contributor

Please add openshift-dedicated and openshift-online too.

@Preeticp

This comment has been minimized.

Copy link
Contributor

commented Oct 11, 2019

@amitkrout what about OpenShift origin?

@kadel

This comment has been minimized.

Copy link
Member

commented Oct 11, 2019

@amitkrout what about OpenShift origin?

we are testing odo heavily with origin 3.11, if we can we can put it in the docs also.
But not sure what is the situation with origin 4.x


* Simple syntax and design centered around concepts familiar to developers, such as projects, applications, and components.
* Completely client based. No server is required within the {product-title} cluster for deployment.
* Supports many languages and frameworks such as Node.js, Java, Ruby, Perl, PHP, and Python.

This comment has been minimized.

Copy link
@kadel

kadel Oct 11, 2019

Member

Officially supported languages are just Node.JS and Java. The rest can't be currently guaranteed :-(

I'm not sure how properly formulate this. Maybe something like this?

  • Support for Node.JS and Java language.
  • Tries to work with any S2I builder image.

This comment has been minimized.

Copy link
@amitkrout

amitkrout Oct 11, 2019

Good catch !!!

@amitkrout

This comment has been minimized.

Copy link

commented Oct 11, 2019

boczkowska I have completed the doc review.
@preethit @kadel As i mentioned above #16627 (comment), IMO the same doc should be available for each 4.2 OpenShift distribution because the cluster web console of all 4.2 distribution displays the availability of command line tools oc and odo. For example in OpenShift online distribution attaching the screenshot for reference.
Screen Shot 2019-10-11 at 11 16 34 AM

Yes, odo will be available in any 4.2 clusters. So documentation should be also there.

@amitkrout did verify that odo is working with Online and Dedicated as well.

@kadel @Preeticp Yes, i have verified odo test script against OpenShift Dedicated more widely with respect to OpenShift Online. I ran the test script (test-cmd-push, test-cmd-url, test-cmd-pref-conf, test-cmd-app) successfully on OpenShift online in single test node due to the resource constraint.

Sometime i shared my OpenShift dedicated cluster among the team (basically with @mik-dass and @prietyc123). Good news is that i did not get any failure complain while they were running their test on the same cluster.

@amitkrout

This comment has been minimized.

Copy link

commented Oct 11, 2019

@amitkrout what about OpenShift origin?

we are testing odo heavily with origin 3.11, if we can we can put it in the docs also.
But not sure what is the situation with origin 4.x

Does even origin uses 4.x cluster ?


{odo-title} is compatible with any language or runtime listed within the OpenShift catalog of component types. For example:

----

This comment has been minimized.

Copy link
@kadel

kadel Oct 11, 2019

Member

This is new output from odo catalog list components it shows the supported and unsupported components, we should probably use this.

Odo Supported OpenShift Components:
NAME       PROJECT       TAGS
java       openshift     11,8,latest
nodejs     openshift     10,8,8-RHOAR,latest

Odo Unsupported OpenShift Components:
NAME              PROJECT       TAGS
dotnet            openshift     2.1,2.2,latest
golang            openshift     1.11.5,latest
httpd             openshift     2.4,latest
modern-webapp     openshift     10.x,latest
nginx             openshift     1.10,1.12,latest
perl              openshift     5.24,5.26,latest
php               openshift     7.0,7.1,7.2,latest
python            openshift     2.7,3.6,latest
ruby              openshift     2.4,2.5,latest
@amitkrout

This comment has been minimized.

Copy link

commented Oct 11, 2019

@amitkrout what about OpenShift origin?

we are testing odo heavily with origin 3.11, if we can we can put it in the docs also.
But not sure what is the situation with origin 4.x

Does even origin uses 4.x cluster ?

Got it,
I never tested odo on OKD 4.* (Upstream). All the time OCP 4* (Downstream) is being used as our test cluster. But i think there won't be much difference between the upstream and downstream code.

@Preeticp @kadel I think ODK 4.* will be a best place for us to get more feedback on how odo works and best place for community people to use/experiment odo

So i am in the favor of keeping the doc for origin 4.x aswell

@kadel

This comment has been minimized.

Copy link
Member

commented Oct 11, 2019

@Preeticp @kadel I think ODK 4.* will be a best place for us to get more feedback on how odo works and best place for community people to use/experiment odo

So i am in the favor of keeping the doc for origin 4.x aswell

But there is no Origin or OKD 4.x release. As far as I know.

@boczkowska

This comment has been minimized.

Copy link
Contributor Author

commented Oct 11, 2019

@amitkrout there are no OKD 4.*(upstream) docs right now. I remember it being discussed with @kadel and we agreed that given the opportunity we will publish our docs on OKD as it gives better exposure in the upstream community. Not in this release though.

I'll be keeping an eye out on OKD and if there would be any changes, I'll keep you guys posted.

@boczkowska boczkowska referenced this pull request Oct 11, 2019
@boczkowska

This comment has been minimized.

Copy link
Contributor Author

commented Oct 11, 2019

I'm closing this PR since this is messy and horrible. New neat PR is #17208 , it is for @bergerhoffer to merge.

If you find any bugs in the docs, please raise them in the Bugzilla: https://bugzilla.redhat.com/
OpenShift Container Platform -> Documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
10 participants
You can’t perform that action at this time.