Examples + docs future #17

pedromorgan · Mar 19, 2017

Manual to the example page

…rmatting

notzippy · Mar 21, 2017

README.md

+Each sub directory contains a standalone [Revel](http://revel.github.io/manual)  application, eg
+
+狂欢是好的，保存UTF8 。保持微笑，享受..抱怨..请让它好看;-)
+

 ```
 go get github.com/revel/samples
 revel run github.com/revel/samples/booking


Shouldn't these say examples now ?

yep.. merge will sort it

do you mean merge from upstream?

shawncatz · Mar 22, 2017

I'm going to go through and redline these changes, bear with me...

pedromorgan · Mar 22, 2017

@shawncatz If u got the source then just commit to patch..

shawncatz · Mar 22, 2017

README.md

+Each sub directory contains a standalone [Revel](http://revel.github.io/manual)  application, eg
+
+狂欢是好的，保存UTF8 。保持微笑，享受..抱怨..请让它好看;-)
+

 ```
 go get github.com/revel/samples
 revel run github.com/revel/samples/booking


do you mean merge from upstream?

shawncatz · Mar 22, 2017

README.md

+- If you have a good sample application idea, then make some noise
+- If you got an app, then please make a pull request 
+- ta ;-)))))))))))))))
+- Early to bed, early to rise, makes a person, healthy and wise .. (code workz)


Documentation should be professional. No "leet" speak, avoid emoticons. Proper language and grammar.

Absolutely agree. We need to keep it professional. You can be goofy in chat, but this style of language is distracting from the purpose of the words. We're not trying to convey a friendly message, we're trying to teach. Keep it simple.

shawncatz · Mar 22, 2017

booking/README.md


 * Using an SQL (SQLite) database and configuring the Revel DB module.
 * Using the third party [GORP](https://github.com/coopernurse/gorp) *ORM-ish* library
 * [Interceptors](../manual/interceptors.html) for checking that an user is logged in.
 * Using [validation](../manual/validation) and displaying inline errors


+Here's a quick summary of the files and purpose


Change this to something like "Project Structure" or just "Structure"

shawncatz · Mar 22, 2017

booking/README.md

-
-
+# Database Install and Setup
+This example used [sqlite](https://www.sqlite.org/), but u can easily adopt code to your needs with mysql, postgres, et all.


"used" => "uses"
Active voice, present tense

"et al" but "etc" is shorter. Also, "u"?? Further, why is this relevant? Isn't this implied?

shawncatz · Mar 22, 2017

booking/README.md

-The booking app uses [go-sqlite3](https://github.com/mattn/go-sqlite3) database driver (which wraps the native C library). 
-
+- The booking app uses [go-sqlite3](https://github.com/mattn/go-sqlite3) database driver, **which wraps the native C library**.
+- This means that the native c code needs to be installed first


I would change this to something like "which depends on the c library", no emphasis.

"C" is a proper pronoun

shawncatz · Mar 22, 2017

twitter-oauth/README.md

+* Fetching mentions for that Twitter account.
+* Tweeting on behalf of that Twitter account.
+
+The core contents of the app:


same as before, "Project Structure"

shawncatz · Mar 22, 2017

twitter-oauth/README.md

+1. The app generates a "request token" and sends the user to Twitter.
+2. The user authorizes the app.
+3. Twitter redirects the user to the provided redirect url, including an
+   "verifier" in the parameters.


"Twitter redirects the user to the provided URL, including a verifier parameter".

shawncatz · Mar 22, 2017

twitter-oauth/README.md

+3. Twitter redirects the user to the provided redirect url, including an
+   "verifier" in the parameters.
+4. The app constructs a request to Twitter using the "request token" and
+   the "verifier", to which Twitter returns the "access token".


"constructs a request to Twitter using request token and verifier, which returns an access token."

shawncatz · Mar 22, 2017

twitter-oauth/README.md

+   "verifier" in the parameters.
+4. The app constructs a request to Twitter using the "request token" and
+   the "verifier", to which Twitter returns the "access token".
+5. The app henceforth uses the access token to operate Twitter on the user's behalf.


Henceforth, the app uses access token to ...

shawncatz · Mar 22, 2017

upload/README.md

+Upload Files
+=========================
+
+TODO # pedro to cosument this


"cosument" = "document" ?

or consummate...

We need to remove this TODO or do it, quickly.

pedromorgan · Mar 22, 2017

Yep agree with all changes and comments.. Merge it ..

brendensoares · May 3, 2017

README.md

-Each directory contains a revel application.
+Each sub directory contains a standalone [Revel](http://revel.github.io/manual)  application, eg
+
+狂欢是好的，保存UTF8 。保持微笑，享受..抱怨..请让它好看;-)


what does this say?

brendensoares · May 3, 2017

booking/README.md


-### To install on OSX:
+### Install sqlite on OSX:


what about pkg-config?

brendensoares · May 3, 2017

booking/README.md

-	$ sudo apt-get install sqlite3 libsqlite3-dev
-
-Once you have SQLite installed, it will be possible to run the booking app:
+### Install sqlite on Ubuntu:


what about the booking install step?

brendensoares · May 3, 2017

README.md


 ```
 go get github.com/revel/samples
 revel run github.com/revel/samples/booking
 ```

-Visit http://revel.github.io for more info
+* [Booking](booking.html) 
+  - A database-driven hotel-booking application, including user management


"hotel-booking" should be "hotel booking"

brendensoares · May 3, 2017

README.md

@@ -1,13 +1,44 @@
 # Sample Revel Applications

-Each directory contains a revel application.
+Each sub directory contains a standalone [Revel](http://revel.github.io/manual)  application, eg


"sub-directory"

Actually, why do we need "sub" at all? In the context of this repo, "each directory" is accurate.

brendensoares · May 3, 2017

chat/README.md

+			chatroom.go
+
+		controllers
+			app.go         # The welcome screen, allowing user to pick a technology


"welcome screen"? Is there a better term for that?

brendensoares · May 3, 2017

chat/README.md

+			websocket.go   # Handlers for the "Websocket" chat demo
+
+		views
+			                # HTML and Javascript


is there JS in the views?

brendensoares · May 3, 2017

twitter-oauth/README.md

+
+The `twitter-oauth` app uses the `mrjones/oauth` library to demonstrate:
+
+* How to do the `oauth` dance to authenticate your app to use a `Twitter` account.


"OAuth" is the correct capitalization. "dance" is not the correct term here.

brendensoares · May 3, 2017

upload/README.md

+Upload Files
+=========================
+
+TODO # pedro to cosument this


or consummate...

brendensoares · May 3, 2017

upload/README.md

+Upload Files
+=========================
+
+TODO # pedro to cosument this


We need to remove this TODO or do it, quickly.

Pi User added 5 commits August 23, 2015 19:11

Making booking app nice.. and testing github rendering

4302fc8

sorry for nice, but checking gh rendering of md.. unwinding jekyll fo…

a134702

…rmatting

making up the readme and unwind jekyll

3923efd

chinese maybe.. a china lady or gentelman

53e458f

undinsing jekyllllll

053619e

pedromorgan changed the title ~~Docs dev~~ Examples + docs future Mar 19, 2017

notzippy added this to the v0.14 milestone Mar 19, 2017

notzippy reviewed Mar 21, 2017

View reviewed changes

shawncatz suggested changes Mar 22, 2017

View reviewed changes

shawncatz added the in progress label Mar 22, 2017

pedromorgan assigned shawncatz Mar 22, 2017

brendensoares modified the milestones: v0.15, v0.14 Mar 24, 2017

notzippy added waffle: progress and removed in progress labels Apr 21, 2017

brendensoares requested changes May 3, 2017

View reviewed changes

notzippy added 4 commits May 3, 2017 14:08

Update README.md

4741c28

Update README.md

e50b3d3

Update README.md

0454267

Update README.md

9821358

notzippy mentioned this pull request May 3, 2017

Fix examples #25

Merged

notzippy closed this May 3, 2017

notzippy removed the waffle: progress label May 3, 2017



		# Database Install and Setup
		This example used [sqlite](https://www.sqlite.org/), but u can easily adopt code to your needs with mysql, postgres, et all.


		The `twitter-oauth` app uses the `mrjones/oauth` library to demonstrate:

		* How to do the `oauth` dance to authenticate your app to use a `Twitter` account.

Search code, repositories, users, issues, pull requests...

Examples + docs future #17

Examples + docs future #17

Uh oh!

Conversation

pedromorgan commented Mar 19, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shawncatz commented Mar 22, 2017

Uh oh!

pedromorgan commented Mar 22, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pedromorgan commented Mar 22, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!