[RCBC-127] Final Review 1.3 core documentation Created: 06/May/13 Updated: 29/May/13 |
|
| Status: | In Progress |
| Project: | Couchbase Ruby client library |
| Component/s: | docs |
| Affects Version/s: | 1.3.0 |
| Fix Version/s: | 1.3.0 |
| Security Level: | Public |
| Type: | New Feature | Priority: | Minor |
| Reporter: | Matt Ingenthron | Assignee: | Karen Zeller |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | info-request | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original Estimate: | Not Specified |
| Sub-Tasks: |
|
| Description |
|
We need a new section in the documentation for the upcoming 1.3.0 release. This should:
- Copy the 1.2 manual - Remove section 3-9, and instead link to the autodocs for the 1.3.0 client - Rename section 10 (now section 3) to "Common Patterns" After this is complete, please pass the ticket to Sergey who will write for review: - Small section on response handling (tmpfail, bulk loading, timeouts) - small section on event machine (motivation, where it is, how to get more info) - small section on transcoders (motivation, where it is, how to use it, how to get more info) I know this is a bit last minute, so we've tried to keep this scope as small as possible and still effective. Our goal would be to have everything done for publishing by EOD on 7th of May. Sorry for the last minute notification. It only became clear in the last few days that this should be a 1.3 release given the new functionality. |
| Comments |
| Comment by Karen Zeller [ 06/May/13 ] |
|
Note to Matt and Sergey: The part you need from me is partially doable in the next hours: We need a new section in the documentation for the upcoming 1.3.0 release. This should: - Copy the 1.2 manual - Remove section 3-9, ….. - Rename section 10 (now section 3) to "Common Patterns" Getting this out depends on how quickly Sergey can assemble the raw information/knowledge in the new files. The other part is if the 1.3 gem ready to run the Rdoc build on ubu-1702. Is it ready now for Rdocs? In order to copyedit them and get my edits in as well as the Rdoc up EOD tomorrow, I will probably need both the code ready and the raw content ready by 2 PM PST tomorrow. I will assign the ticket to Sergey as soon as the 1.3 files are set up in the next hour. Regards, Karen |
| Comment by Karen Zeller [ 06/May/13 ] |
|
-Creating new files for 1.3 -Updating link to new Rdoc 1.3 from nav -Add Ruby 1.3 to LibrarySpec.pm to publish |
| Comment by Karen Zeller [ 06/May/13 ] |
|
Assigning to Sergey to add content to new files in sections described.
Sergey, the 1.3 XML chapters are in: docs/Couchbase/products/couchbase/couchbase-sdk-ruby-1.3 Let me know when you have added all your raw content as XML for each of the section. I will copyedit them/reorganize, request information from you if needed and the publish. |
| Comment by Sergey Avseyev [ 07/May/13 ] |
| Thank you Karen, I've just uploaded to review site two new code examples, which I'm going to use in new documentation sections: http://review.couchbase.org/26153 |
| Comment by Karen Zeller [ 07/May/13 ] |
|
And don't worry about organizing this clearly for now, just get the raw information and knowledge you have into XML paragraphs and lists. |
| Comment by Sergey Avseyev [ 07/May/13 ] |
|
EventMachine section: https://github.com/couchbase/docs/pull/211 Transcoders section (depends on previous one, because it is modifying the same file): https://github.com/couchbase/docs/pull/212 |
| Comment by Karen Zeller [ 07/May/13 ] |
|
HI Sergey,
So I edited and overhauled your new content and committed it to Github. Do you guys have a list of standard reviewers I should send this to? Also, there were some areas that were unclear: -For Data Transcoders you say these transcoders can be chosen using the current format API, therefore the patch won't break anything. I believe this means that this is compatible with earlier versions of the Ruby SDK. Correct> -:forced passes the transcoder explicitly. I believe that means that the operations will transcode automatically, please confirm.... -EventMachine. You say that the Ruby client comes with additional engines. But I think this really means it comes with two engines: a default which is Ruby-thread-friendly , and the one which extends EventMachine -Final note: where are any release notes? Changed status to minor as going into reviews then publish soon.... |
| Comment by Matt Ingenthron [ 07/May/13 ] |
|
Thanks for the quick turnaround on this Karen! Again apologies for the scramble. For ruby, we do not have a current list of standard reviewers. I might recommend myself and James Mauss (he's a Ruby guy to some degree). |
| Comment by Karen Zeller [ 08/May/13 ] |
| Karen: run the Rdoc for 1.3. |
| Comment by Sergey Avseyev [ 08/May/13 ] |
| I've attached zip archive to announcement email |
| Comment by Karen Zeller [ 08/May/13 ] |
| Ok, uploaded and linked: http://www.couchbase.com/autodocs/ |
[RCBC-119] Error handling documentation Created: 05/Feb/13 Updated: 11/Feb/13 |
|
| Status: | Reopened |
| Project: | Couchbase Ruby client library |
| Component/s: | docs |
| Affects Version/s: | 1.2.1 |
| Fix Version/s: | 1.3.0 |
| Security Level: | Public |
| Type: | Improvement | Priority: | Major |
| Reporter: | Perry Krug | Assignee: | Sergey Avseyev |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
Please create some documentation specifying possible error/failures to operations, what they "look" like in the logs/exceptions/stack traces and what our recommendation is on how to handle them.
i.e. tmp_oom, timeouts (connection/operation/java-internal/etc), "get miss" (it's technically a failure, let's make it overly obvious what it means), CAS failure, add() failure, replace() failure, Some of this should be covered in the API reference, but this bug is specifically for a single page where this information is aggregated that a customer/user could read about how to handle errors. |