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 #2372

Closed
wants to merge 16 commits into from

Conversation

simon-dew
Copy link
Collaborator

@simon-dew simon-dew commented Jan 19, 2022

Replaced by #2373

simon-dew and others added 16 commits January 19, 2022 20:23
* Rewrite Choose Your Next Steps to distinguish Developer Guides and Developer Information

* Add Developer Guides overview

* Update Nav
* DOC-9119: improving description of rebalancing in abstracts and headings. (couchbase#2213)

* DOC-9237: Clarify views deprecation in relnotes (couchbase#2215)

* DOC-9240: remove reference to query tree from query-workbench docs (couchbase#2217)

* DOC-9240: remove reference to query tree from query-workbench.adoc. Add note about removal to relnotes.adoc

* DOC-9240: query-workbench-result-tree.png is no longer in use.

* Doc 9018 document charts on query workbench (couchbase#2216)

* DOC-9018: Adding  Query workbench chart documentation

* Put tree stuff back in because it's handled by DOC-9240

* DOC-9018: Changed query-workbench-result-plan.png, so it looks a bit more like the callouts describing it.

* DOC-9018: Tidying up the numbers

* DOC-6760: Added redirect (couchbase#2168)

* DOC-9080: added entries for Debian 11.x support (couchbase#2221)

* DOC-8891: Added prometheus to list of managed logs (couchbase#2104)

* DOC-8894: Updated bucket durability on create and edit bucket (couchbase#2105)

* DOC-8923: Fixed typo (couchbase#2121)

* DOC-8929: Updated screenshot (couchbase#2127)

* DOC-8931: Added note on audit file deletion responsibility (couchbase#2130)

* DOC-8997: Information on xdcr between pre and post 7.0 (couchbase#2155)

* DOC-9019: Added new metrics for analytics, data service, and cluster manager (couchbase#2208)

* DOC-9099: Modified XDCR Advanced Settings and general internal settin… (couchbase#2190)

* DOC-9099: Modified XDCR Advanced Settings and general internal settingspages

* DOC-9099: Added review feedback

* DOC-9099: Updated statement on HLV

* DOC-9103for7.0: Updated command name (couchbase#2193)

* DOC-9116: Updated reference to xdcr and expiration (couchbase#2197)

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* DOC-9094for7.0: Re-included cbsummary (couchbase#2195)

* Doc 9012 (couchbase#2158)

* DOC-9012: Modified password-design advice

* DOC-9012: New password-creation advice

* DOC-6667for7.0: Added redirect for intra-cluster replication (couchbase#2144)

* Eventing REST API 7.0 updates (couchbase#2226)

* Eventing REST API 7.0 updates

Very important for 7.0 (no changes for 7.0.1 or 7.0.2) need for CONNECT

Organize and group into logical sections
Add several missing important endpoints (export, appcode, list, etc.)
Improve descriptions
Fix typos

* Add final /api/v1/list/functions filter

/api/v1/list/functions/query?function_type=sbm
/api/v1/list/functions/query?function_type=notsbm

* Add page-alias for query string query page (couchbase#2228)

* Add page-alias for query string query page

* Update fts-query-string-syntax.adoc

Corrected macro name; added extension to file

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* Doc 9222 (couchbase#2212)

* DOC-9222: Draft release notes for 7.0.2

* DOC-9222: Release Notes for 7.0.2

* DOC-9222: Additional fixed issues for release notes for 7.0.2

* DOC-9222: Fixed links

* DOC-9222: Added to new features section for release notes

* DOC-9222: Additional fixes and modifications

* DOC-9222: Incorporated review feedback

* DOC-9222: Added line on Eventing feature

* DOC-9222: Added MB-48713

* DOC-9222: Added feedback on Index Service tickets

* DOC-8540: Added information on strict value for cluster encryption-level (couchbase#2135)

* DOC-8540: Added information on strict value for cluster encryption-level

* DOC-8540: Wording change to description of strict option

* DOC-8540: Added information on consequences of strict TLS enablement

* DOC-8540: Additional information and links related to strict encryption level

* DOC-8540: Clarified server version as 7.0.2+

* DOC-9021: Added statement on effect of revEpoch (couchbase#2165)

* DOC-9017: Standard Index Storage for Ephemeral Buckets (couchbase#2201)

* DOC-9017: Standard Index Storage for Ephemeral Buckets

* DOC-9017: Added note on editions

* DOC-9016: Updated UI for create cluster (couchbase#2159)

* DOC-9016: Updated UI for create cluster

* DOC-9016: Updated address family information for CLI and REST Initialization

* DOC-9178: Added info on new license restriction for node-count in CE 7.0+ (couchbase#2207)

* DOC-9192: Added information on alternate address for target cluster (couchbase#2210)

* DOC-9192: Added information on alternate address for target cluster

* DOC-9192: Added review feedback

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* DOC-9066: Added instructions to windows install (couchbase#2211)

* DOC-9066: Added instructions to windows install

* DOC-9066: Added initial bullet on admin privileges

* DOC-9093: Added audit events (couchbase#2186)

* DOC-6535: Added redirect (couchbase#2178)

* Revert "Doc 9222" - Some changes needed for PHP build (couchbase#2231)

* Revert "Doc 9222 (couchbase#2212)"

This reverts commit 444f566.

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* DOC-9177: Added note on 7.0.2 IP Address Families (couchbase#2205)

* Revert "Revert "Doc 9222" - Some changes needed for PHP build (couchbase#2231)" (couchbase#2232)

This reverts commit ef5f2fb.

* Removed statement: "Couchbase Server supports durability for single-document writes only." (couchbase#2233)

* Fix bad line wrap (couchbase#2229)

* Fix bad line wrap

No line breaks as I intended in this example in actual formatting outside of git - so broke it up into two code blocks

* fix method on POST for /config

* Fix methods for /appcode

* Updated release note for MB-48783 (couchbase#2234)

* Updated release note

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* Added note about new charts on query workbench (couchbase#2235)

* Alias fix (couchbase#2238)

* 11.x not ready to go yet. (couchbase#2242)

* Add changes to query workbench to release note (couchbase#2236)

* Added note about new charts on query workbench

* Added QueryBench charts to new features section: relnotes.adoc

* Removed issue reference for chart addition to Query workbench: relnotes.adoc

* DOC-9252: Capella Rebrand (couchbase#2247)

* Quick typo fix (couchbase#2230)

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
Co-authored-by: Tony Hillman <tonyjhillman@gmail.com>
Co-authored-by: Jon Strabala <54073900+jon-strabala@users.noreply.github.com>
Co-authored-by: Richard Smedley <rgsmedley@gmail.com>
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Co-authored-by: Brian Kane <38470665+BKaneAtWork@users.noreply.github.com>
* DOC-9119: improving description of rebalancing in abstracts and headings. (couchbase#2213)

* DOC-9237: Clarify views deprecation in relnotes (couchbase#2215)

* DOC-9240: remove reference to query tree from query-workbench docs (couchbase#2217)

* DOC-9240: remove reference to query tree from query-workbench.adoc. Add note about removal to relnotes.adoc

* DOC-9240: query-workbench-result-tree.png is no longer in use.

* Doc 9018 document charts on query workbench (couchbase#2216)

* DOC-9018: Adding  Query workbench chart documentation

* Put tree stuff back in because it's handled by DOC-9240

* DOC-9018: Changed query-workbench-result-plan.png, so it looks a bit more like the callouts describing it.

* DOC-9018: Tidying up the numbers

* DOC-6760: Added redirect (couchbase#2168)

* DOC-9080: added entries for Debian 11.x support (couchbase#2221)

* DOC-8891: Added prometheus to list of managed logs (couchbase#2104)

* DOC-8894: Updated bucket durability on create and edit bucket (couchbase#2105)

* DOC-8923: Fixed typo (couchbase#2121)

* DOC-8929: Updated screenshot (couchbase#2127)

* DOC-8931: Added note on audit file deletion responsibility (couchbase#2130)

* DOC-8997: Information on xdcr between pre and post 7.0 (couchbase#2155)

* DOC-9019: Added new metrics for analytics, data service, and cluster manager (couchbase#2208)

* DOC-9099: Modified XDCR Advanced Settings and general internal settin… (couchbase#2190)

* DOC-9099: Modified XDCR Advanced Settings and general internal settingspages

* DOC-9099: Added review feedback

* DOC-9099: Updated statement on HLV

* DOC-9103for7.0: Updated command name (couchbase#2193)

* DOC-9116: Updated reference to xdcr and expiration (couchbase#2197)

Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>

* DOC-9094for7.0: Re-included cbsummary (couchbase#2195)

* Doc 9012 (couchbase#2158)

* DOC-9012: Modified password-design advice

* DOC-9012: New password-creation advice

* DOC-6667for7.0: Added redirect for intra-cluster replication (couchbase#2144)

* Eventing REST API 7.0 updates (couchbase#2226)

* Eventing REST API 7.0 updates

Very important for 7.0 (no changes for 7.0.1 or 7.0.2) need for CONNECT

Organize and group into logical sections
Add several missing important endpoints (export, appcode, list, etc.)
Improve descriptions
Fix typos

* Add final /api/v1/list/functions filter

/api/v1/list/functions/query?function_type=sbm
/api/v1/list/functions/query?function_type=notsbm

* Add page-alias for query string query page (couchbase#2228)

* Add page-alias for query string query page

* Update fts-query-string-syntax.adoc

Corrected macro name; added extension to file

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* Doc 9222 (couchbase#2212)

* DOC-9222: Draft release notes for 7.0.2

* DOC-9222: Release Notes for 7.0.2

* DOC-9222: Additional fixed issues for release notes for 7.0.2

* DOC-9222: Fixed links

* DOC-9222: Added to new features section for release notes

* DOC-9222: Additional fixes and modifications

* DOC-9222: Incorporated review feedback

* DOC-9222: Added line on Eventing feature

* DOC-9222: Added MB-48713

* DOC-9222: Added feedback on Index Service tickets

* DOC-8540: Added information on strict value for cluster encryption-level (couchbase#2135)

* DOC-8540: Added information on strict value for cluster encryption-level

* DOC-8540: Wording change to description of strict option

* DOC-8540: Added information on consequences of strict TLS enablement

* DOC-8540: Additional information and links related to strict encryption level

* DOC-8540: Clarified server version as 7.0.2+

* DOC-9021: Added statement on effect of revEpoch (couchbase#2165)

* DOC-9017: Standard Index Storage for Ephemeral Buckets (couchbase#2201)

* DOC-9017: Standard Index Storage for Ephemeral Buckets

* DOC-9017: Added note on editions

* DOC-9016: Updated UI for create cluster (couchbase#2159)

* DOC-9016: Updated UI for create cluster

* DOC-9016: Updated address family information for CLI and REST Initialization

* DOC-9178: Added info on new license restriction for node-count in CE 7.0+ (couchbase#2207)

* DOC-9192: Added information on alternate address for target cluster (couchbase#2210)

* DOC-9192: Added information on alternate address for target cluster

* DOC-9192: Added review feedback

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>

* DOC-9066: Added instructions to windows install (couchbase#2211)

* DOC-9066: Added instructions to windows install

* DOC-9066: Added initial bullet on admin privileges

* DOC-9093: Added audit events (couchbase#2186)

* DOC-6535: Added redirect (couchbase#2178)

* Revert "Doc 9222" - Some changes needed for PHP build (couchbase#2231)

* Revert "Doc 9222 (couchbase#2212)"

This reverts commit 444f566.

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* DOC-9177: Added note on 7.0.2 IP Address Families (couchbase#2205)

* Revert "Revert "Doc 9222" - Some changes needed for PHP build (couchbase#2231)" (couchbase#2232)

This reverts commit ef5f2fb.

* Removed statement: "Couchbase Server supports durability for single-document writes only." (couchbase#2233)

* Fix bad line wrap (couchbase#2229)

* Fix bad line wrap

No line breaks as I intended in this example in actual formatting outside of git - so broke it up into two code blocks

* fix method on POST for /config

* Fix methods for /appcode

* Updated release note for MB-48783 (couchbase#2234)

* Updated release note

* Gardening

Co-authored-by: Richard Smedley <rgsmedley@gmail.com>

* Added note about new charts on query workbench (couchbase#2235)

* Alias fix (couchbase#2238)

* 11.x not ready to go yet. (couchbase#2242)

* Add changes to query workbench to release note (couchbase#2236)

* Added note about new charts on query workbench

* Added QueryBench charts to new features section: relnotes.adoc

* Removed issue reference for chart addition to Query workbench: relnotes.adoc

* DOC-9252: Capella Rebrand (couchbase#2247)

* Quick typo fix (couchbase#2230)

* DOC-9290: Note on re-addition of removed nodes (couchbase#2239)

* page alias (couchbase#2251)

* Revert "page alias (couchbase#2251)" (couchbase#2252)

This reverts commit 472e875.

* 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

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>
Co-authored-by: Amarantha Kulkarni <amarantha-k@users.noreply.github.com>
Co-authored-by: Tony Hillman <tonyjhillman@gmail.com>
Co-authored-by: Jon Strabala <54073900+jon-strabala@users.noreply.github.com>
Co-authored-by: Richard Smedley <rgsmedley@gmail.com>
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Co-authored-by: Brian Kane <38470665+BKaneAtWork@users.noreply.github.com>
…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
Add prerelease label to dev-reorg branch
* Branch needs own version identifier
* 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
…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
* 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.
…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
…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
* 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
Copy link
Collaborator Author

Too many merge conflicts. Take off and nuke the site from orbit.

@simon-dew simon-dew closed this Jan 19, 2022
@simon-dew simon-dew deleted the dev-reorg branch January 25, 2022 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants