[RCBC-103] Improvements to the Getting Started Guide and the Tutorial Created: 20/Dec/12  Updated: 13/Jan/14

Status: Open
Project: Couchbase Ruby client library
Component/s: docs
Affects Version/s: 1.2.0
Fix Version/s: None
Security Level: Public

Type: Improvement Priority: Major
Reporter: Michael Nitschinger Assignee: Amy Kurtzman
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
Ruby Docs

*** Getting Started ***

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/installing_the_couchbase_client_libraries.html
- link broken: ... is libcouchbase. Please consult [C Client Library page about w ...

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/hello_couchbase.html
- In the list where the conn params are explained, maybe explain why I need to ouse the list param
when I have more then one node (where I have to use host?)? Its not really obvious why I have two
different args for the same type.
- Maybe add a quick sentence what marhsal does? Serialzining ruby objects? Note that you cant use
views with it.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/creating_and_updating_documents.html
- here it talks about the :plain mode and I'm confused, whats the different to :marshal? Maybe
good to explain in a sentence.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/reading_documents.html
- Where basic view querying is explained, I think we need to add a sentence or two on how
a second HTTP request is maed when you access the design document. Since you ask an array here,
is it prefetched? how does it work? Would be good to know so that people dont use it in a loop
for example.

*** Tutorial **

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_tl_dr.html
- I think you need to tell people how to install bundler? I have it, but I'm not sure if it comes
by default? If it is always there forget this comment :)

- Sign in with twitter gives me 401 unauthorized.. do we really need this and is it supposed to
work? Otherwise the sample app works out of the box, cool work.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_create_application_skeleton.html
- Can you explain the --old-style-hash in a sentence? Dont know what it is?
- The short gem description only contains omniauth-twitter, but the full also omniauth?
- maybe mention to update the dependencies after the changes? bundle update?

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_implement_controllers.html
- Where you explain the controller functionality: it's not really obvios how the methods map to the
views. What will happen when you access a different method that has no view defined? Just a few
words to explain how the "magical" vie access works would be good I think.

http://www.couchbase.com/docs/couchbase-sdk-ruby-1.2/_bonus_spatial_queries_sessions_and_cache.html
- On caching: will it use the same couchbase client connection or instantiate a new one?

Otherwise good job! :)

 Comments   
Comment by Sergey Avseyev [ 13/Jan/14 ]
This is notes for older version of the docs. Could you check if any of those relevant? And open separate issues if needed. Thanks
Generated at Fri Oct 24 08:01:47 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.