Update readme.md , move service details to docs dir, add logo, add faq #25

nomthy · 2017-02-24T11:56:21Z

Addresses #20 and #24

Moved docs under one directory
Added a FAQ section
Added link to lagom gitter chat page
Added link to Lagom git repository
Added link to Lagom hello world tutorial

Possible additions are:

Screenshots or animated gif showing the auction site in use

nomthy · 2017-02-25T15:56:01Z

@TimMoore @ignasi35 Made changes. Please review

TimMoore

This looks great. Thanks, @nomthysmylz!

ignasi35 · 2017-02-27T16:49:11Z

README.md


-## Queries handled
+This is a sample Scala auction site using the Lagom Framework. A java version of the auction site is also available [here](https://github.com/lagom/online-auction-java) 


"There's also a java version of this sample app available."

I prefer not using the word 'here' for linking.

ignasi35 · 2017-02-27T16:49:39Z

README.md

-* **getItem** - Gets an item by an ID.
-* **getItemsForUser** - Gets a list of items in a provided status that are owned by a given user.
+## Getting started
+To get started make sure you have sbt and git installed on your system. You will also need an active internet connection.


ignasi35 · 2017-02-27T16:52:18Z

README.md


-## Queries handled
+We recommend using a decent machine and having at least 8GB of RAM for development.


Either specify the machine we recommend or avoid vague statement like decent.

Feel free to remove the System requirements section if you are unfamiliar with the minimum requirements now.

ignasi35 · 2017-02-27T16:54:04Z

README.md


-## Events emitted
+For a simple, gentler, introduction to Lagom, have a look at the [Hello World Tutorial](http://www.lagomframework.com/documentation/1.3.x/scala/GettingStarted.html) in the docs. 


Hello World is not a tutorial but a Gitter8 seed. This statement could confuse users making them think there's more when they click on the link than what there really is.

ignasi35 · 2017-02-27T16:54:13Z

README.md


-## Commands handled
+If you have any troubles and need help, feel free to ask in the [Gitter channel](https://gitter.im/lagom/lagom)


ignasi35 · 2017-02-27T16:56:14Z

docs/item-service.md

+## Events emitted
+
+* **AuctionStarted** (public) - When the auction is started, in response to **startAuction**.
+* **ItemUpdated** (private) - When user editable fields on an item are updated in response to **createItem**.


Is this page copy paster from the online-auction-java?

Note to self: I'm not sure the scala version currently complies with this docs. We'll have to review later... Since the Edit Item feature is being worked on in a separate PR we can review this docs when the feature is complete.

Hmmm.... I had use ItemEvent.scala#L13 as my reference and the event is listed in the current README.md

ignasi35 · 2017-02-27T16:57:10Z

README.md

@@ -1,135 +1,61 @@
-# Auction system
+[![Lagom](docs/logo.png)](https://github.com/lagom/lagom)



logo looks great but too big IMHO.

Please resize to half or less. See https://gist.github.com/uupaa/f77d2bcf4dc7a294d109

Fixed this made it 50% of window size

ignasi35

This is looking great. I'd like @rstento to have a look at the main page (readme.md) when @nomthysmylz considers this mergeable.

nomthy · 2017-03-01T10:15:50Z

@ignasi35 made changes

rstento · 2017-03-06T16:16:14Z

Is this the only documentation on using online auction? If it is, I think it should include a description of what to expect when you run it, and how to use it, create items, bids, etc. If that exists elsewhere, the readme should link to it.

…

On Sun, Mar 5, 2017 at 11:36 PM, Tim Moore ***@***.***> wrote: @TimMoore <https://github.com/TimMoore> requested your review on: lagom/online-auction-scala#25 <#25> Update readme.md , move service details to docs dir, add logo, add faq. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AV1DexjOOM0GnvWevDhLsDUcvTFx1Rkvks5ri5tDgaJpZM4MLIQO> .

-- Ruth Stento User Experience Lead Lightbend 512-818-6459 <http://lightbend.com>

TimMoore · 2017-03-08T03:39:03Z

@rstento are you OK with merging this pull request as is and then adding usage documentation in a separate, future one?

We would also need to add it to the Java version.

rstento · 2017-03-08T03:40:47Z

absolutely, we can further enhance in the future.

…

On Tue, Mar 7, 2017 at 9:39 PM, Tim Moore ***@***.***> wrote: @rstento <https://github.com/rstento> are you OK with merging this pull request as is and then adding usage documentation in a separate, future one? We would also need to add it to the Java version. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AV1De4TSx2stjNOdI1j8FNAZEwZVoeUtks5rjiLYgaJpZM4MLIQO> .

-- Ruth Stento User Experience Lead Lightbend 512-818-6459 <http://lightbend.com>

TimMoore · 2017-03-08T03:41:32Z

README.md


-System architecture:
+[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/lagom/lagom?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [<img src="https://img.shields.io/travis/lagom/lagom.svg"/>](https://travis-ci.org/lagom/lagom)


Now that we have a Travis CI build for this project, it probably makes sense to use the badge for that build rather than the main lagom/lagom one https://travis-ci.org/lagom/online-auction-scala

TimMoore · 2017-03-08T06:12:29Z

I'll go ahead and merge this now, but if you'd like to update the Travis CI badge in a separate pull request, that would be a great next step. Thanks!

nomthy force-pushed the update-readme.md branch 3 times, most recently from 1096451 to 81bbd67 Compare February 25, 2017 15:52

nomthy changed the title ~~WIP: README.md overhaul~~ Update readme.md , move service details to docs dir, add logo, add faq Feb 25, 2017

TimMoore approved these changes Feb 27, 2017

View reviewed changes

TimMoore requested a review from ignasi35 February 27, 2017 00:52

ignasi35 reviewed Feb 27, 2017

View reviewed changes

ignasi35 suggested changes Feb 27, 2017

View reviewed changes

nomthy force-pushed the update-readme.md branch 6 times, most recently from 3f5a8ee to c1feb66 Compare March 1, 2017 10:02

Update README.md and add user service

a6d2987

nomthy force-pushed the update-readme.md branch from c1feb66 to a6d2987 Compare March 1, 2017 10:04

ignasi35 approved these changes Mar 2, 2017

View reviewed changes

TimMoore requested a review from rstento March 6, 2017 05:36

yg-apaza mentioned this pull request Mar 8, 2017

README: Add project context lagom/online-auction-java#50

Merged

TimMoore reviewed Mar 8, 2017

View reviewed changes

TimMoore merged commit 9447db4 into lagom:master Mar 8, 2017

ignasi35 mentioned this pull request Mar 9, 2017

Port README and docs changes from online-auction-java #20

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update readme.md , move service details to docs dir, add logo, add faq #25

Update readme.md , move service details to docs dir, add logo, add faq #25

nomthy commented Feb 24, 2017 •

edited

Loading

nomthy commented Feb 25, 2017 •

edited

Loading

TimMoore left a comment

ignasi35 Feb 27, 2017

ignasi35 Feb 27, 2017

ignasi35 Feb 27, 2017

nomthy Mar 1, 2017

ignasi35 Feb 27, 2017

ignasi35 Feb 27, 2017

ignasi35 Feb 27, 2017

nomthy Mar 1, 2017

ignasi35 Feb 27, 2017

nomthy Mar 1, 2017

ignasi35 left a comment

nomthy commented Mar 1, 2017

rstento commented Mar 6, 2017 via email

TimMoore commented Mar 8, 2017

rstento commented Mar 8, 2017 via email

TimMoore Mar 8, 2017

TimMoore commented Mar 8, 2017


		## Queries handled
		This is a sample Scala auction site using the Lagom Framework. A java version of the auction site is also available [here](https://github.com/lagom/online-auction-java)


		## Queries handled
		We recommend using a decent machine and having at least 8GB of RAM for development.


		## Events emitted
		For a simple, gentler, introduction to Lagom, have a look at the [Hello World Tutorial](http://www.lagomframework.com/documentation/1.3.x/scala/GettingStarted.html) in the docs.


		## Commands handled
		If you have any troubles and need help, feel free to ask in the [Gitter channel](https://gitter.im/lagom/lagom)

		@@ -1,135 +1,61 @@
		# Auction system
		[![Lagom](docs/logo.png)](https://github.com/lagom/lagom)


		System architecture:
		[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/lagom/lagom?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [<img src="https://img.shields.io/travis/lagom/lagom.svg"/>](https://travis-ci.org/lagom/lagom)

Update readme.md , move service details to docs dir, add logo, add faq #25

Update readme.md , move service details to docs dir, add logo, add faq #25

Conversation

nomthy commented Feb 24, 2017 • edited Loading

nomthy commented Feb 25, 2017 • edited Loading

TimMoore left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ignasi35 left a comment

Choose a reason for hiding this comment

nomthy commented Mar 1, 2017

rstento commented Mar 6, 2017 via email

TimMoore commented Mar 8, 2017

rstento commented Mar 8, 2017 via email

Choose a reason for hiding this comment

TimMoore commented Mar 8, 2017

nomthy commented Feb 24, 2017 •

edited

Loading

nomthy commented Feb 25, 2017 •

edited

Loading