adding example java docs #1153

sherl0cks · 2018-12-19T00:12:03Z

What is the purpose of this change? What does it change?

Was the change discussed in an issue?

fixes #???
#839, but does not completely resolve. #839 suggests that the getting started page include java. This makes sense, but is a more involved rewrite. I would suggest the team 1) split 839 and 2) use the example from the katacoda to rewrite the getting started docs for java and node

How to test changes?

It's a doc change.

A couple notes:

due to Support Context Dir Like oc new-app #1152, I cannot use any of the red hat repos for java examples as they need --context-dir support. Thus, I'm using Spring Pet Clinic here.
I think it would be good to refactor this whole page to include all commands needed for a working example (e.g. odo push & odo url create). Creating the component is only one part of the job and makes the docs a bit confusing.

codeclimate · 2018-12-19T00:12:38Z

Code Climate has analyzed commit c5e3bc8 and detected 0 issues on this pull request.

View more on Code Climate.

AppVeyorBot · 2018-12-19T00:30:16Z

✅ odo build 833 completed and artifacts can be found here (for commit 56f53b89a0 by @sherl0cks)

codecov · 2018-12-19T00:41:25Z

Codecov Report

Merging #1153 into master will increase coverage by 0.68%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master   #1153      +/-   ##
=========================================
+ Coverage   42.51%   43.2%   +0.68%     
=========================================
  Files          28      29       +1     
  Lines        4081    4111      +30     
=========================================
+ Hits         1735    1776      +41     
+ Misses       2166    2147      -19     
- Partials      180     188       +8

Impacted Files	Coverage Δ
pkg/occlient/utils.go	`100% <0%> (ø)`
pkg/occlient/occlient.go	`47.69% <0%> (+0.59%)`	⬆️
pkg/util/util.go	`60.65% <0%> (+1.83%)`	⬆️
pkg/component/watch.go	`70.58% <0%> (+2.61%)`	⬆️
pkg/service/service.go	`60.71% <0%> (+2.64%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ee2371...c5e3bc8. Read the comment docs.

geoand · 2018-12-19T08:21:30Z

@cdrage Weren't you working on something similar?

cdrage · 2018-12-19T14:26:34Z

docs/examples.md

@@ -1,6 +1,6 @@
 # Examples

-Odo is compatible with any language or runtime listed within OpenShift's catalog of component types.
+Odo is compatible with any language or runtime listed within OpenShift's catalog of component types. To create url for component, see the [cli reference for `odo url`](cli-reference.md#url).


Rather than showing how to create url, the wording could possibly be better with this:

In order to access a component, you may create a URL using odo url create

Or something along those lines

How about now?

cdrage · 2018-12-19T14:27:04Z

@geoand

Sort of. I'm creating a doc on how to setup a database and link it to a component. How to push both your back-end and front-end systems.

geoand · 2018-12-19T14:27:51Z

Thanks @cdrage

sherl0cks · 2018-12-19T17:09:19Z

@cdrage where can I follow along the component / database docs? I need them personally and would also like to contribute back.

sherl0cks · 2018-12-19T17:11:56Z

This thread also makes me thing we should look at #1155

geoand · 2018-12-19T17:14:55Z

@sherl0cks although it's definitely not documentation, we have various integration tests that use java.

I think the one that @cdrage is planning his docs update on is this and the code that uses it can be found here

AppVeyorBot · 2018-12-19T17:26:19Z

✅ odo build 836 completed and artifacts can be found here (for commit 1180c5ef15 by @sherl0cks)

metacosm · 2018-12-20T14:13:31Z

docs/examples.md

+  git clone https://github.com/spring-projects/spring-petclinic.git
+  cd spring-petclinic
+  mvn package
+  odo create java test3 --binary target/*.jar


Not sure you want to push all jars all the time. Usually, you only push the uber-jar…

Generally speaking, when packaging as an uber jar, you will only get a single jar in target - the uber jar. If you hard code the name of that, simple things like maven version changes can break automation

Generally true, yes but still risky :)

OK - how about odo create java petclinic --binary target/spring-petclinic-*.jar ? I'm trying to avoid spring reving the version and breaking the example.

sherl0cks · 2019-01-02T17:51:09Z

bump

geoand · 2019-01-07T08:23:12Z

@cdrage Can you please take a look at this when you have some time? Thanks

surajnarwade · 2019-01-14T13:20:36Z

cc @cdrage @metacosm , your 💚 is needed here 😄

cdrage

Docs LGTM. Just a minor change.

cdrage · 2019-01-14T21:31:29Z

docs/examples.md

@@ -80,6 +89,18 @@ Build and run WildFly applications on CentOS 7. For more information about using

 ## Binary example

+### java 
+
+Java can be used to deploy binary artifact


Java may be used to deploy a binary artifact, for example:

Or something similar ^^

cdrage · 2019-01-14T21:31:48Z

docs/examples.md

@@ -88,3 +109,4 @@ WildFly can deploy a binary application.
  wget -O example.war 'https://github.com/appuio/hello-world-war/blob/master/repo/ch/appuio/hello-world-war/1.0.0/hello-world-war-1.0.0.war?raw=true'
  odo create wildfly --binary example.war
 ```
+


newline added by mistake?

sherl0cks · 2019-01-14T22:06:40Z

@cdrage done.

May I suggest the team look at a more optimistic merging approach? A one month cycle time for a small docs update with changes for newlines isn't the greatest new contributor experience. I realize the holidays got in there, but still something to consider.

AppVeyorBot · 2019-01-14T22:18:21Z

✅ odo build 990 completed and artifacts can be found here (for commit 42e99f83a1 by @sherl0cks)

cdrage · 2019-01-14T23:03:41Z

LGTM!

cdrage · 2019-01-14T23:04:53Z

@sherl0cks Yeah, we need to improve on merging. We talked about this at the face-to-face meeting we had last week and we're going to be creating a newly updated DOC for merging / PR review procedures.

I send the link to the team too! http://hintjens.com/blog:106

adding example java docs

b4b1b19

cdrage reviewed Dec 19, 2018

View reviewed changes

update per suggestions

0edd5af

metacosm reviewed Dec 20, 2018

View reviewed changes

geoand approved these changes Jan 3, 2019

View reviewed changes

cdrage suggested changes Jan 14, 2019

View reviewed changes

fixes per PR

c5e3bc8

cdrage approved these changes Jan 14, 2019

View reviewed changes

cdrage merged commit 3b0227a into redhat-developer:master Jan 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding example java docs #1153

adding example java docs #1153

sherl0cks commented Dec 19, 2018

codeclimate bot commented Dec 19, 2018 •

edited

Loading

AppVeyorBot commented Dec 19, 2018

codecov bot commented Dec 19, 2018 •

edited

Loading

geoand commented Dec 19, 2018

cdrage Dec 19, 2018

sherl0cks Dec 19, 2018

cdrage commented Dec 19, 2018

geoand commented Dec 19, 2018

sherl0cks commented Dec 19, 2018

sherl0cks commented Dec 19, 2018

geoand commented Dec 19, 2018

AppVeyorBot commented Dec 19, 2018

metacosm Dec 20, 2018

sherl0cks Dec 20, 2018 •

edited

Loading

metacosm Dec 20, 2018

sherl0cks Dec 20, 2018 •

edited

Loading

sherl0cks commented Jan 2, 2019

geoand commented Jan 7, 2019

surajnarwade commented Jan 14, 2019 •

edited

Loading

cdrage left a comment

cdrage Jan 14, 2019

cdrage Jan 14, 2019

sherl0cks commented Jan 14, 2019 •

edited

Loading

AppVeyorBot commented Jan 14, 2019

cdrage commented Jan 14, 2019

cdrage commented Jan 14, 2019

adding example java docs #1153

adding example java docs #1153

Conversation

sherl0cks commented Dec 19, 2018

What is the purpose of this change? What does it change?

Was the change discussed in an issue?

How to test changes?

codeclimate bot commented Dec 19, 2018 • edited Loading

AppVeyorBot commented Dec 19, 2018

codecov bot commented Dec 19, 2018 • edited Loading

Codecov Report

geoand commented Dec 19, 2018

cdrage Dec 19, 2018

Choose a reason for hiding this comment

sherl0cks Dec 19, 2018

Choose a reason for hiding this comment

cdrage commented Dec 19, 2018

geoand commented Dec 19, 2018

sherl0cks commented Dec 19, 2018

sherl0cks commented Dec 19, 2018

geoand commented Dec 19, 2018

AppVeyorBot commented Dec 19, 2018

metacosm Dec 20, 2018

Choose a reason for hiding this comment

sherl0cks Dec 20, 2018 • edited Loading

Choose a reason for hiding this comment

metacosm Dec 20, 2018

Choose a reason for hiding this comment

sherl0cks Dec 20, 2018 • edited Loading

Choose a reason for hiding this comment

sherl0cks commented Jan 2, 2019

geoand commented Jan 7, 2019

surajnarwade commented Jan 14, 2019 • edited Loading

cdrage left a comment

Choose a reason for hiding this comment

cdrage Jan 14, 2019

Choose a reason for hiding this comment

cdrage Jan 14, 2019

Choose a reason for hiding this comment

sherl0cks commented Jan 14, 2019 • edited Loading

AppVeyorBot commented Jan 14, 2019

cdrage commented Jan 14, 2019

cdrage commented Jan 14, 2019

codeclimate bot commented Dec 19, 2018 •

edited

Loading

codecov bot commented Dec 19, 2018 •

edited

Loading

sherl0cks Dec 20, 2018 •

edited

Loading

sherl0cks Dec 20, 2018 •

edited

Loading

surajnarwade commented Jan 14, 2019 •

edited

Loading

sherl0cks commented Jan 14, 2019 •

edited

Loading