Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-9196: How-to Guides for Server Developers #2373

Merged
merged 11 commits into from Jan 25, 2022

Commits on Jan 19, 2022

  1. DOC-9204: Developer Guides Overview (couchbase#2224)

    * Rewrite Choose Your Next Steps to distinguish Developer Guides and Developer Information
    
    * Add Developer Guides overview
    
    * Update Nav
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    bc84eb3 View commit details
    Browse the repository at this point in the history
  2. DOC-9206: How-to Guides for Server Developers: Query — Read Data (cou…

    …chbase#2249)
    
    * Add select howto
    
    * Add query how-to landing page
    
    * Add mock SDK examples
    
    * Dhinu's feedback
    
    * Add thmbnails for tools links
    
    * Add developer guides overview
    
    * Canonical order of SDKs
    
    * Update SDK examples with includes
    
    * Move SELECT intro examples to separate files
    
    * Move LIMIT examples to separate files
    
    * Move ORDER BY examples to separate files
    
    * Add local how-to guide examples
    
    * Include external example files
    
    * Use new Python and Node.js "Hello World" examples
    
    * Update FROM clause example
    
    * Update nav for stage 1
    
    * Fix missing attribute in WINDOW Clause
    
    * Update GROUP BY reference to share examples
    
    * Update UNNEST reference to share examples
    
    * Update NEST reference to share examples
    
    * Rewrite explanation of lookup join and index join
    
    * Add join and nest diagrams
    
    * Update JOIN reference to share examples
    
    * Add query how-tos
    
    * Add partials
    
    * Update nav with how-tos
    
    * Add how-to examples
    
    * Add one-line explanation for code samples
    
    * Omit legacy join syntax and legacy nest syntax
    
    * Move Aggregate Function examples to separate files
    
    * Consistent ellipses in examples
    
    * Add list of aggregate functions
    
    * Indexes for nest and join
    
    * Reduce Before you begin and Query tools sections
    
    * Complete examples, add tags and callouts
    
    * Rephrase "recursive" joins
    
    * Minor nav fix
    
    * Move ANSI NEST examples to reference
    
    * Rework lookup join examples as inner and left join
    
    * Minor fixes for examples
    
    * Oops
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    80663ec View commit details
    Browse the repository at this point in the history
  3. DOC-9207: Query — Manipulate Data (couchbase#2277)

    * Separate out MERGE, DELETE, (some) INSERT, UPDATE, and UPSERT examples
    
    * Formatting and markup updates
    
    * Add data warning partial
    
    * Update examples
    
    * Sort out some of the problems with Collection Ops
    
    * Add DELETE guide, INSERT guide, and UPDATE guide
    
    * Update Nav
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    171e98e View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    038efc1 View commit details
    Browse the repository at this point in the history
  5. DOC-9217: How-to Guides for Server Developers › Index Advisor (couchb…

    …ase#2331)
    
    * Move ADVISOR examples to functions
    
    * Update ADVISOR examples with ellipses
    
    * Separate out ADVISE examples
    
    * Add Index Advisor guide
    
    * DOC-9240: Restore query result tree
    
    * DOC-9240: Add patch release markup for 7.0-7.0.1
    
    * DOC-9018: Move Charts section under Query Results and rewrite for Couchbase Server 7.0.2
    
    * DOC-9018: replace screenshots
    
    * Minor updates
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    173bc67 View commit details
    Browse the repository at this point in the history
  6. Doc 9216 import data (couchbase#2317)

    * DOC-9216: Import Data guide
    
    Import guide covering:
    
     - 4 most common formats: CSV, TSV, JSON, JSONL
     - cbimport
     - importing using 4 popular SDKs (Java, .NET, Node.js, Python)
    
    Out of scope:
     - manual import using the admin panel
     - Kafka streaming import
    
    We introduce `cbimport` as this covers most of the important topics of import within a single CLI command.
    
    The SDK import is split into:
    
     - parsing CSV/TSV
     - parsing JSON/JSONL
     - connecting to the couchbase server
     - final preprocessing and import
    
    Where possible, we feature Streaming approach (which will tie in with upcoming Kafka streaming import work).  In particular:
    
     - Java gives examples in traditional blocking API and Reactive API.
     - .NET and Node.js are both "async first" SDKs so only async approach demonstrated
     - Python examples are traditional blocking, and we also call out the `multi` batch mode import. 
    NB: this does mean that the asyncio `acouchbase` API isn't documented for import, this will be covered during future Kafka guide.
    osfameron authored and simon-dew committed Jan 19, 2022
    Copy the full SHA
    03491d4 View commit details
    Browse the repository at this point in the history
  7. DOC-9210: How-to Guides for Server Developers › Transactions (couchba…

    …se#2353)
    
    * Update transactions settings layout in N1QL Support for Couchbase Transactions
    
    * Add single transaction example
    
    * Add multi-statement transaction example and update results
    
    * Add screenshots for transactions how-to guide
    
    * Add transactions how-to guide
    
    * Update transaction information docs to use how-to guide examples
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    3fbbf8b View commit details
    Browse the repository at this point in the history
  8. DOC-9209: How-to Guides for Server Developers › Query › Indexes (couc…

    …hbase#2307)
    
    * Separate CREATE INDEX example files
    
    * Separate index with META() example files
    
    * Separate index partitioning example files
    
    * Fix example formatting and line wrapping
    
    * Separate alter index example files
    
    * Rearrange CREATE INDEX examples
    
    * Separate out BUILD INDEX examples
    
    * Update examples with context
    
    * Separate out DROP INDEX examples
    
    * Tidy up ALTER INDEX
    
    * Tidy up DROP INDEX examples
    
    * Add Creating Indexes
    
    * Separate out USE INDEX examples
    
    * Add Index Placement
    
    * Add Deferring Indexes
    
    * Add Selecting Indexes
    
    * Add Dropping Indexes
    
    * Update Nav
    
    * Fix examples and formatting
    
    * Remove Adaptive Indexes
    
    * Minor updates
    
    * Add new SDK examples for building indexes
    
    * Add new SDK examples for creating indexes
    
    * Add new SDK examples for dropping indexes
    
    * Add links to using indexes with SDKs
    
    * Fixing errors
    
    * Add indexes overview page
    
    * Expand SDK instructions
    
    * Extend pagination across page width
    
    * Pagination fix
    
    * Markup errors
    
    * Use SDK index example files and remove local index example files
    
    * Driveby include fix for aggregate functions
    
    * Fix broken link in Selecting Indexes
    
    * Fix broken Python example links
    
    * Move explanation of primary index name out of the procedure
    
    * SDKs do not support indexes on named collections
    
    * Tidy procedures for dropping named and unnamed primary indexes
    
    * Add SDK examples to create named primary indexes
    
    * Add SDK examples for composite indexes
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    94d2ae7 View commit details
    Browse the repository at this point in the history
  9. Copy the full SHA
    d0a9ca2 View commit details
    Browse the repository at this point in the history
  10. DOC-9204: Developer Guides Overview (couchbase#2371)

    * DOC-9209: transaction fixes
    
    * DOC-9216: Minor wording changes for consistency
    
    * Reorganize Queries how-to
    
    * Reorganize Indexes how-to
    
    * Reorganize Data Manipulation how-to
    
    * Drive-by fix on Index Placement
    
    * Update nav and overview pages
    
    * DOC-9412: Update nav and overview page
    simon-dew committed Jan 19, 2022
    Copy the full SHA
    6815586 View commit details
    Browse the repository at this point in the history

Commits on Jan 25, 2022

  1. Updates after review

    simon-dew committed Jan 25, 2022
    Copy the full SHA
    ab53c7c View commit details
    Browse the repository at this point in the history