[PYCBC-102] New Python 1.0 Guide Created: 08/May/13 Updated: 08/May/13 |
|
| Status: | Open |
| Project: | Couchbase Python Client Library |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Security Level: | Public |
| Type: | Task | Priority: | Major |
| Reporter: | Karen Zeller | Assignee: | Matt Ingenthron |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | info-request | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
MarkN the component lead.
Matt: will have schedule next week. |
[PYCBC-113] TOC for Python 1.0 Created: 15/May/13 Updated: 15/May/13 |
|
| Status: | Open |
| Project: | Couchbase Python Client Library |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Security Level: | Public |
| Type: | Bug | Priority: | Major |
| Reporter: | Matt Ingenthron | Assignee: | Matt Ingenthron |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
For the upcoming 1.0 Python client, we'll need to come up with a TOC. Likely something like MB-7714.
|
| Comments |
| Comment by Karen Zeller [ 15/May/13 ] |
|
Not sure who is the subject matter expert on Python but we need input on the topics. Here is the TOC for Java-next-gen:
1. Getting Started 1.1 Preparations 1.2 Hello Couchbase 1.3 Next Steps 2. Tutorial 2.1 Preparations 2.2 Quickstart 2.3 Connection Management 2.4 The Welcome Page 2.5 Managing Beers 2.6 Wrapping Up 3. Using the APIs 3.1 Connection Management 3.2 Retreiving Data 3.3 Mutating Data 3.4 Working with Views 3.5 Applying Persistence Constraints 3.6 Error Handling 3.7 JSON & Object Serialization 3.8 Design Document Management 4. Advanced Usage 4.1 Bulk Loading 4.2 Working with Documents 4.3 Advanced Topics 4.4 Logging & Debugging 5. API Reference 5.1 Method Summary 5.2 Connecting & Disconnecting 5.3 Retreiving Data 5.4 Mutating Data 5.5 Management Operations 5.6 Other Useful Operations A. Release Notes B. Contributing B.1 General Information B.2 Source Code Styleguide |
| Comment by Matt Ingenthron [ 15/May/13 ] |
|
Mark ist he SME.
Mark: Using this as a base (unless you have feedback to the contrary), can you edit up a TOC for the Python 1.0 release in this ticket? |
| Comment by Mark Nunberg [ 15/May/13 ] |
|
I'd probably want to nix (for now):
2.3 Connection Management (it's a simple object, there's no global pooling yet) 3.4 Views (we don't have a stable view API yet) 3.8 "" 3.5 "" 4.4 We don't have any significant logging infrastructure in the SDK We might want to split 'Preparations' into 'Installing the SDK' and 'Installing the cluster' Thus: -------------------------------------------------------------------------------------------------------------------------- 1. Getting Started 1.1 Setting up the cluster 1.2 Installing the SDK 1.3 Hello Couchbase 1.4 Next Steps 2. Tutorial 2.1 Preparations 2.2 Quickstart 2.3 Connection Management 2.4 The Welcome Page 2.5 Managing Beers 2.6 Wrapping Up 3. Using the APIs 3.1 Connecting 3.2 Retreiving Data 3.3 Mutating Data 3.4 Working with Views [ NYI (Not Yet implemented) ] 3.5 Applying Persistence Constraints [ NYI ] 3.6 Error Handling 3.7 JSON & Object Serialization 3.8 Design Document Management [ NYI ] 4. Advanced Usage 4.1 Bulk Loading 4.2 Notes for using with (and without) threads (maybe this belogns in advanced)? 4.3 Working with Documents 4.4 Advanced Topics 4.5 Logging & Debugging 5. API Reference 5.1 Method Summary 5.2 Initialization 5.3 Retreiving Data 5.4 Mutating Data 5.5 Management Operations 5.6 Other Useful Operations A. Release Notes B. Contributing B.1 General Information B.2 Source Code Styleguide |
| Comment by Mark Nunberg [ 15/May/13 ] |
| Assigning back to you for review |