Add help text in README for creation, retrieval, listing of WorkItemTypes #195

pranavgore09 · 2016-09-06T06:21:35Z

taken from examples/workitemtype.adoc

Fixes #208

This change is

kwk · 2016-09-06T06:54:53Z

Hi @pranavgore09 . In principle I'd say this is a good thing to have in the README but we might want to inform the user about potential problems simply because of duplicate keys. The user can only create the Epic work item type once and after that she or he will get the duplicate key error.

pranavgore09 · 2016-09-06T07:48:21Z

yes @kwk you are right, updating....

aslakknutsen · 2016-09-06T09:14:01Z

Wondering if we should move to testable examples in the source code instead of writing everything up in the README. The README is getting quite large with light and deep setup info and other things. It looks like the project is super complicated, when really it's not.

We could in the README just point to the examples folder, and in the example folder have testable examples (testable in the sense of being automatically tested and verified): https://blog.golang.org/examples

?

pranavgore09 · 2016-09-06T10:28:28Z

goa-design supports example attribute for fields which will reflect in swagger. - doc

kwk · 2016-09-06T11:01:29Z

@aslakknutsen @pranavgore09 or we could use those examples for tests with the final deploy image.

aslakknutsen · 2016-09-06T15:32:37Z

@kwk That's what I'm wondering about... related #178

alexeykazakov · 2016-09-07T00:15:25Z

README.adoc


 ----
-$ ./bin/alm-cli create workitem --payload '{"type": "1" , "name": "some name", "fields": { "system.owner": "tmaeder", "system.state": "open" }}' -H localhost:8080
+$ ./bin/alm-cli create workitem --payload '{"type": "Epic" , "name": "some name", "fields": { "system.owner": "tmaeder", "system.state": "open" }}' -H localhost:8080


Epic? Epic is not available. And It looks like "system.state": "open" is not available either. Should be "new" instead. And "system.title" is missing?

@alexeykazakov : yes you are right few keys are missing and have different values. But this is just an example data for creating WIT. With help of this dummy data, user can build n number of WITs with different possible values.

And I think somewhere else in the document we should teach the user about available (bootstrapped) WITs.

Remove "name", it's no longer in API

@alexeykazakov @pranavgore09 The WorkItem definition match the WorkitemType created further up, so not wrong in that sense. e.g. system.state is just a string.

@pranavgore09 If you add some text like: Based on the WorkItemType we created above, we can now create a WorkItem...

Ah, ok. Makes sense now. Thanks for clarification.

pranavgore09 · 2016-09-07T03:48:39Z

@kwk : Yes but before that I want to understand - when we do make test-all, these test examples will run or not ?
And will these examples make use of API call OR it will call create method of workitem_repository ? And for final deploy image, which database will be used for these examples ? because one can run examples 100 times, should there be 100 WITs every time ? (considering unique key constraints and all)

aslakknutsen · 2016-09-07T23:43:10Z

README.adoc

-Create a work item.
+Create a work item type.
+----
+./bin/alm-cli create workitemtype --payload '{"extendedTypeName":null,"fields":{"system.owner":{"Type":{"Kind":"user"},"Required":true},"system.state":{"Type":{"Kind":"string"},"Required":false}},"name":"Epic"}' -H localhost:8080 --pp


Remove extendedTypeName

pranavgore09 · 2016-09-08T04:20:00Z

Review status: 0 of 1 files reviewed at latest revision, 2 unresolved discussions, some commit checks failed.

README.adoc, line 265 [r1] (raw file):

Previously, aslakknutsen (Aslak Knutsen) wrote…

Remove extendedTypeName

Because it is optional ? and we are not focusing "extend" yet ?

README.adoc, line 283 [r1] (raw file):

Previously, alexeykazakov (Alexey Kazakov) wrote…

Ah, ok. Makes sense now. Thanks for clarification.

Yup, I thought "We need to use name of work item type in the `type` field below." will be helpful for reader, but yeah will make it more verbose.

Comments from Reviewable

aslakknutsen · 2016-09-08T09:47:51Z

README.adoc, line 265 [r1] (raw file):

Previously, pranavgore09 (Pranav Gore) wrote…

Because it is optional ? and we are not focusing "extend" yet ?

Yes, and it doesn't add anything to the example.

Comments from Reviewable

pranavgore09 · 2016-09-12T06:58:21Z

Review status: 0 of 1 files reviewed at latest revision, 2 unresolved discussions, some commit checks failed.

README.adoc, line 265 at r1 (raw file):

Previously, aslakknutsen (Aslak Knutsen) wrote…

Yes, and it doesn't add anything to the example.

Yup removed.

Comments from Reviewable

codecov-io · 2016-09-19T07:35:03Z

Current coverage is 22.08% (diff: 100%)

Merging #195 into master will not change coverage

@@             master       #195   diff @@
==========================================
  Files            32         32          
  Lines          1173       1173          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits            259        259          
  Misses          863        863          
  Partials         51         51

Powered by Codecov. Last update fc426e5...ee0f7cc

pranavgore09 · 2016-09-20T01:17:28Z

@aslakknutsen : this is a small doc change. I think it is ready to merge. Can you please take a look ?
Fixes #208

aslakknutsen · 2016-09-20T01:32:06Z

@pranavgore09 Can you rebase and re-push

aslakknutsen · 2016-09-20T01:33:26Z

@pranavgore09 This does not fix #187 See https://github.com/almighty/almighty-core/blob/8a4a85c391d8bda112c3d86f2ca082d8dd10ae02/design/user_types.go#L24 for example

…ype.

pranavgore09 · 2016-09-20T01:57:02Z

Rebase done.
Thanks @aslakknutsen . Yes this does not fix #187 . added by mistake.

pranavgore09 mentioned this pull request Sep 6, 2016

Add real example data to WorkItemType payload #187

Closed

pranavgore09 force-pushed the iss-187 branch 2 times, most recently from f32f59e to 8746362 Compare September 6, 2016 07:57

aslakknutsen mentioned this pull request Sep 6, 2016

fix readme example for creating workitem #208

Closed

alexeykazakov reviewed Sep 7, 2016
View reviewed changes

pranavgore09 force-pushed the iss-187 branch from 8746362 to 7d8bdb5 Compare September 7, 2016 04:00

aslakknutsen mentioned this pull request Sep 7, 2016

Updated CLI command example for creating a work item #210

Closed

pranavgore09 force-pushed the iss-187 branch from 7d8bdb5 to eaf5cfb Compare September 7, 2016 13:28

aslakknutsen reviewed Sep 7, 2016
View reviewed changes

pranavgore09 force-pushed the iss-187 branch from eaf5cfb to ef4aa5c Compare September 8, 2016 04:22

pranavgore09 force-pushed the iss-187 branch from ef4aa5c to 8627c6b Compare September 10, 2016 09:04

pranavgore09 force-pushed the iss-187 branch 2 times, most recently from d353126 to 39ebd7b Compare September 16, 2016 08:26

pranavgore09 force-pushed the iss-187 branch from 7703f7f to 7dee48d Compare September 19, 2016 07:18

pranavgore09 added the documentation label Sep 19, 2016

pranavgore09 force-pushed the iss-187 branch 2 times, most recently from cc314ce to ee0f7cc Compare September 19, 2016 10:56

aslakknutsen approved these changes Sep 20, 2016

View reviewed changes

Add help text in README for creation, retrieval, listing of WorkItemT…

2cc704e

…ype.

pranavgore09 force-pushed the iss-187 branch from ee0f7cc to 2cc704e Compare September 20, 2016 01:54

aslakknutsen merged commit 845254f into fabric8-services:master Sep 20, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add help text in README for creation, retrieval, listing of WorkItemTypes #195

Add help text in README for creation, retrieval, listing of WorkItemTypes #195

pranavgore09 commented Sep 6, 2016 •

edited

kwk commented Sep 6, 2016

pranavgore09 commented Sep 6, 2016

aslakknutsen commented Sep 6, 2016

pranavgore09 commented Sep 6, 2016 •

edited

kwk commented Sep 6, 2016

aslakknutsen commented Sep 6, 2016 •

edited

alexeykazakov Sep 7, 2016

pranavgore09 Sep 7, 2016

aslakknutsen Sep 7, 2016

aslakknutsen Sep 7, 2016

alexeykazakov Sep 7, 2016

pranavgore09 commented Sep 7, 2016

aslakknutsen Sep 7, 2016

pranavgore09 commented Sep 8, 2016

aslakknutsen commented Sep 8, 2016

pranavgore09 commented Sep 12, 2016

codecov-io commented Sep 19, 2016 •

edited

pranavgore09 commented Sep 20, 2016 •

edited

aslakknutsen commented Sep 20, 2016

aslakknutsen commented Sep 20, 2016

pranavgore09 commented Sep 20, 2016

Add help text in README for creation, retrieval, listing of WorkItemTypes #195

Add help text in README for creation, retrieval, listing of WorkItemTypes #195

Conversation

pranavgore09 commented Sep 6, 2016 • edited

kwk commented Sep 6, 2016

pranavgore09 commented Sep 6, 2016

aslakknutsen commented Sep 6, 2016

pranavgore09 commented Sep 6, 2016 • edited

kwk commented Sep 6, 2016

aslakknutsen commented Sep 6, 2016 • edited

alexeykazakov Sep 7, 2016

Choose a reason for hiding this comment

pranavgore09 Sep 7, 2016

Choose a reason for hiding this comment

aslakknutsen Sep 7, 2016

Choose a reason for hiding this comment

aslakknutsen Sep 7, 2016

Choose a reason for hiding this comment

alexeykazakov Sep 7, 2016

Choose a reason for hiding this comment

pranavgore09 commented Sep 7, 2016

aslakknutsen Sep 7, 2016

Choose a reason for hiding this comment

pranavgore09 commented Sep 8, 2016

aslakknutsen commented Sep 8, 2016

pranavgore09 commented Sep 12, 2016

codecov-io commented Sep 19, 2016 • edited

Current coverage is 22.08% (diff: 100%)

pranavgore09 commented Sep 20, 2016 • edited

aslakknutsen commented Sep 20, 2016

aslakknutsen commented Sep 20, 2016

pranavgore09 commented Sep 20, 2016

pranavgore09 commented Sep 6, 2016 •

edited

pranavgore09 commented Sep 6, 2016 •

edited

aslakknutsen commented Sep 6, 2016 •

edited

codecov-io commented Sep 19, 2016 •

edited

pranavgore09 commented Sep 20, 2016 •

edited