Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-7714

Restructuring Language References

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Won't Fix
    • Major
    • None
    • 2.0.1
    • None
    • Security Level: Public
    • 50

    Description

      I've been thinking about restructuring the Java Guides because I find it
      rather confusing. So I propose the following new structure, which takes
      enhancements and new features into account as well. Any inputs would be
      greatly appreciated!

      Here are the main changes

      • Moving the "Reference" into its own subsection, clearing out the main
        level
      • Providing more information on using the APIs, also with 2.0 content.
      • Getting started & tutorial mainly unchanged.

      1. Getting Started
      1.1 Preparations
      1.2 Hello Couchbase
      1.3 Working with Documents
      1.4 Advanced Topics
      1.5 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 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

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            akurtzman Amy Kurtzman (Inactive)
            kzeller kzeller
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty