DOC-13295: Preliminary release notes (#881)

* Add new features to release notes
* Highlight future changes to Enable Shared Bucket Access
* Highlight future changes to Disable All Public Docs
* Fix broken attributes

Author: simon-dew

modules/ROOT/pages/_partials/_define_page_index.adoc

@@ -206,7 +206,7 @@ endif::xref--pfx-sgw[]
 :configuration-schema-database--page: configuration-schema-database.adoc
 :configuration-schema-database--xref: {sgw--xref}{configuration-schema-database--page}[Database Configuration]
 
-:configuration-schema-database--xref--enable-shared-bucket-access: {sgw--xref}{configuration-schema-database--page}#database-enable_xttrs[database.enable_shared_bucket_access]
+:configuration-schema-database--xref--enable-shared-bucket-access: {sgw--xref}{configuration-schema-database--page}#enable_shared_bucket_access[database.enable_shared_bucket_access]
 
 :configuration-schema-database--xref-user-xattr-key: {sgw--xref}{configuration-schema-database--page}#databases-this_db-user_xattr_key[user_xattr_key]
 
@@ -457,7 +457,7 @@ endif::xref--pfx-sgw[]
 :configuration-schema-database--xref--delta-sync-max-age: {configuration-schema-database--pfx--db}-delta_sync-rev_max_age_seconds[database.delta_sync.rev_max_age_seconds]
 
 :configuration-schema-database--xref--import-filter: {configuration-schema-database--pfx--db}-import_filter[database.import_filter]
-:configuration-schema-database--xref--import-docs: {configuration-schema-database--pfx--db}-import_docs[database.import_docs]
+:configuration-schema-database--xref--import-docs: {configuration-schema-database--pfx}#import_docs[database.import_docs]
 
 :configuration-schema-database--xref--oidc: {configuration-schema-database--pfx--oidc}[oidc]
 :configuration-schema-database--xref--oidc-username-claim: {configuration-schema-database--pfx--oidc}-providers-this_provider-username_claim[username_claim]

modules/ROOT/pages/_partials/release_notes/sync-gateway-3-3-0-release-note.adoc

@@ -2,7 +2,18 @@
 
 include::partial$block-caveats.adoc[tags=eventing-mixed-mode]
 
-=== TODO: New Feature
+=== Partitioned Indexes
+
+Sync Gateway 3.3 introduces support for partitioned indexes.
+Partitioned indexes offer horizontal scalability for large deployments by sharding indexes across multiple nodes.
+
+=== Disable the Public All Docs Endpoint
+
+Sync Gateway 3.3 introduces an option to disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API.
+
+=== Interactive Admin Credentials for SG Collect Info
+
+In Sync Gateway 3.3 and later, the `sgcollect_info` tool provides an interactive password prompt so that you can enter administrative credentials.
 
 For more information on new features and enhancements in this release, see xref:whatsnew.adoc[].
 

modules/ROOT/pages/sync-with-couchbase-server.adoc

@@ -8,6 +8,7 @@ ifdef::prerelease[:page-status: {prerelease}]
 :description: Use Sync Gateway to sync Couchbase Server changes securely from cloud to edge
 :keywords: sync gateway, replication, sync, synchronization, edge, cloud
 :pageOriginRel: "sg=1.5, Cbs=5.0)_"
+:imagesdir: ../assets/images
 
 include::partial$_set_page_context.adoc[]
 
@@ -20,7 +21,7 @@ include::partial$block-standard-footnotes.adoc[tags=sgw1x5;cbs5x0]
 :fn-sgw: footnote:fn-sgw[Prior to Release 2.5, Server 5.0 all writes had to go through Sync Gateway, or had to use bucket shadowing to ensure that the security and replication metadata needed by mobile applications was preserved.]
 // :fn-sgw-ref: footnote:fn-sgw[]
 
-:enable-sba-config-item: {configuration-schema-database--pfx--db}-enable_shared_bucket_access[$dbname.enable_shared_bucket_access]
+:enable-sba-config-item: {configuration-schema-database--pfx}#enable_shared_bucket_access[$dbname.enable_shared_bucket_access]
 :xattr--page: xref:server:learn:data/extended-attributes-fundamentals.adoc[Extended Attributes (XATTR)]
 
 include::partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"]
@@ -29,16 +30,16 @@ include::partial$block-caveats.adoc[tags="cbs6.0ke-xattrs"]
 == Introduction
 
 
-{sgw-te} will automatically sync database changes if {configuration-schema-database--xref--import-docs} and {configuration-schema-database--xref--enable-shared-bucket-access} are set 'true'.
+{sgw-t} will automatically sync database changes if {configuration-schema-database--xref--import-docs} and {configuration-schema-database--xref--enable-shared-bucket-access} are set 'true'.
 
-* Enable_Shared_Bucket_Access
-+
-This setting ensures that both {sgw} and {cbs-te} can read and write to the same bucket simultaneously and that {sgw} can access {cbs} document XATTRS +
+enable_shared_bucket_access::
+This setting ensures that both {sgw-t} and {cbs-t} can read and write to the same bucket simultaneously and that {sgw-t} can access {cbs} document XATTRS +
 See: <<sgw-paths>> and {configuration-schema-database--xref--enable-shared-bucket-access}.
-
-* Import Docs
 +
-Setting this property true ensures that the {sgw} node performs import processing, obtaining the mobile metadata it requires to replicate changes -- see: <<import-process>>.
+Setting this property to `true` will be required in a future release, and `false` will not be supported.
+
+import_docs::
+Setting this property true ensures that the {sgw-t} node performs import processing, obtaining the mobile metadata it requires to replicate changes -- see: <<import-process>>.
 
 You can configure both these properties using the Admin Rest API {configuration-schema-database--xref} endpoint.
 
@@ -53,7 +54,7 @@ image::shared-bucket-access.png[]
 
 Mobile applications require additional metadata in order to manage security and replication.
 
-{sgw} stores this information using {cbs} XATTRs (see {cbs} documentation on {server-data-xattr-fundamentals--xref}).
+{sgw-t} stores this information using {cbs} XATTRs (see {cbs} documentation on {server-data-xattr-fundamentals--xref}).
 
 
 === Extended Attributes (XATTRs)
@@ -71,24 +72,24 @@ Extended attributes:
 * Can be accessed via {cbs} SDKs using the sub-document API, via command-line tools, and via views.
 
 * Are accessible from {sqlpp} in {cbs} using the `().xattrs` property. +
-For example, `SELECT meta().xattrs._sync from travel-sample where Meta().id = "user::demo"`;.
+For example, `SELECT meta().xattrs._sync from travel-sample where Meta().id = "user::demo";`.
 
 
-Both {sgw} and {cbs} use a System extended attribute, with the following characteristics to support mobile convergence (shared bucket access):
+Both {sgw-t} and {cbs} use a System extended attribute, with the following characteristics to support mobile convergence (shared bucket access):
 
 * Shares lifetime with the document metadata - when a document is deleted, system xattrs are preserved with the tombstone.
 * Allocated 1MB of storage, independent of the 20MB available for the document
 
-WARNING: The sync metadata is maintained internally by {sgw} and its structure can change at any time.
+WARNING: The sync metadata is maintained internally by {sgw-t} and its structure can change at any time.
 It should not be used to drive business logic of applications.
 The direct use of the {sqlpp} query is unsupported and must not be used in production environments.
-The `_raw` endpoint (/db/_raw/{docid}) on {sgw}'s Admin REST API returns both the document and its associated mobile metadata.
+The `_raw` endpoint (/db/_raw/{docid}) on {sgw-t}'s Admin REST API returns both the document and its associated mobile metadata.
 
 === Documents
 
-With bucket-sharing enabled, {cbs} documents can be inserted directly (using _{sqlpp}_ or _SDKs_) or by using {sgw}'s {rest-api--xref}.
+With bucket-sharing enabled, {cbs} documents can be inserted directly (using {sqlpp} or SDKs) or by using {sgw-t}'s {rest-api--xref}.
 
-{sgw} {fn-sgw1x5} creates the metadata it needs by abstracting it from the SDK or {sqlpp} applications reading and writing data directly to {cbs} buckets.
+{sgw-t} {fn-sgw1x5} creates the metadata it needs by abstracting it from the SDK or {sqlpp} applications reading and writing data directly to {cbs} buckets.
 It uses {cbs} XATTRs {fn-cbs5x0} to store that metadata into an external document fragment -- see {xref-svr-pg-xattrs}.
 
 // The REST API will also include the following behavioral changes:
@@ -99,7 +100,7 @@ It uses {cbs} XATTRs {fn-cbs5x0} to store that metadata into an external documen
 === Blobs and Attachments
 
 .Couchbase Server SDK/{sqlpp}
-Use {sgw}'s REST API's {xref-sgw-ep-public-api-attachment} endpoints to
+Use {sgw-t}'s REST API's {xref-sgw-ep-public-api-attachment} endpoints to
 manage attachments and blob data; you cannot use {cbs} SDKs to do this
 directly.
 
@@ -114,7 +115,7 @@ Couchbase Lite apps seamlessly handle blobs and attachments, see the appropriate
 include::partial$blocklinks-cbl.adoc[]
 
 .Using a WebApp
-Attachments can be accessed through {sgw}'s REST API using the xref:rest_api_public.adoc#tag/Document-Attachment/operation/get_keyspace-docid-attach[+/{keyspace}/{docid}/{attach}+] endpoint.
+Attachments can be accessed through {sgw-t}'s REST API using the xref:rest_api_public.adoc#tag/Document-Attachment/operation/get_keyspace-docid-attach[+/{keyspace}/{docid}/{attach}+] endpoint.
 
 === Tombstone Revisions
 
@@ -131,19 +132,19 @@ The {sqlpp} query language {fnref-cbs5x0} supports the ability to query these ex
 [#simple-query]
 .Querying XATTRS-bsed sync metadata
 ====
-[source,sql]
+[source,sqlpp]
 ----
 SELECT meta().xattrs._sync FROM scope.collection WHERE meta().id = "mydocId"
 ----
 ====
 
-WARNING: The sync metadata is maintained internally by {sgw} and its structure can change at any time.
+WARNING: The sync metadata is maintained internally by {sgw-t} and its structure can change at any time.
 It should not be used to drive business logic of applications. The direct use of the {sqlpp} query is *unsupported* and must not be used in production environments.
 
 === Enable Shared Bucket Access
 
 Shared bucket access is an opt-in feature.
-You can enable it without bringing down the entire {sgw} cluster  -- see <<enable-sba>>.
+You can enable it without bringing down the entire {sgw-t} cluster  -- see <<enable-sba>>.
 
 [#enable-sba]
 .Enable Bucket-Sharing
@@ -160,7 +161,7 @@ You can enable it without bringing down the entire {sgw} cluster  -- see <<enabl
     }
 }
 ----
-<.> The `import_docs` property is used to specify that a {sgw} node participates (exclusively) in {import-process--xref}. The mechanism by which {sgw} incorporates changes to data buckets it shares with {cbs} -- see: <<import-process>>.
+<.> The `import_docs` property is used to specify that a {sgw-t} node participates (exclusively) in {import-process--xref}. The mechanism by which {sgw-t} incorporates changes to data buckets it shares with {cbs} -- see: <<import-process>>.
 
 ====
 
@@ -170,30 +171,37 @@ You can enable it without bringing down the entire {sgw} cluster  -- see <<enabl
 
 
 The *import process* is a key part of mobile convergence.
-It is the means by which {sgw} becomes aware of non-{sgw} data changes and obtains the mobile metadata it requires to replicate changes.
+It is the means by which {sgw-t} becomes aware of non-{sgw-t} data changes and obtains the mobile metadata it requires to replicate changes.
 
 image::shared-bucket-access.png[]
 
-Any non-{sgw} change is eligible for import.
+Any non-{sgw-t} change is eligible for import.
 The document is first run through the Sync Function to compute read security and routing, with the following differences:
 
-* The import is processed with an admin user context in the Sync Function, similar to writes made through the {sgw} Admin API.
+* The import is processed with an admin user context in the Sync Function, similar to writes made through the {sgw-t} Admin API.
 This means that `requireAccess`, `requireUser` and `requireRole` calls in the Sync Function are treated as no-ops.
 * During import, `oldDoc` is `nil` when the Sync Function is executed.
 
-You can specify a filter function using the {configuration-schema-database--pfx--db}_import_filter[import_filter] property, which will only import specific documents.
+You can specify a filter function using the {configuration-schema-database--pfx}#import_filter[import_filter] property, which will only import specific documents.
 
 TIP: Use the {bootstrap-schema--xref--logging-console-log-keys} log key to troubleshoot import processing issues in the logs.
 
 === Configuration
 
 Note that `import_docs` only takes effect if the `enabled_shared_bucket_access` is set to `true`.
 
-{enterprise}::
+****
+[.edition]#{enterprise}#
+
 The `import_docs` parameter defaults to `true`, implying that, by default, all nodes in a cluster participate in import processing.
 To exclude a node, set `"import_docs": false`.
-{community}::
-The `import_docs` parameter defaults to false and must be explicitly set to `true`.
+
+'''
+
+[.edition]#{community}#
+
+The `import_docs` parameter defaults to `false` and must be explicitly set to `true`.
+****
 
 The following table describes the key behavior differences between Community Edition and Enterprise Edition when `import_docs` is enabled, disabled or not set at all.
 
@@ -233,7 +241,7 @@ The following table describes the key behavior differences between Community Edi
 |===
 
 === High Availability
-In _Enterprise Edition_, import processing work is sharded across all {sgw} nodes with import enabled.
+In _Enterprise Edition_, import processing work is sharded across all {sgw-t} nodes with import enabled.
 This implies that if one of the nodes fail, the failed shard is automatically picked up by the remaining nodes in the cluster.
 This way, you get High Availability of import processing.
 
@@ -246,7 +254,7 @@ As described in the table above, if `import_docs` is set to `false`, the node wi
 This configuration is specifically recommended for workload isolation: to isolate import nodes from the client-facing nodes.
 Workload isolation may be preferable in deployments with high write throughput.
 
-The following diagram shows an example architecture of two {sgw} nodes handling the incoming client connections (`import_docs: false`) and two nodes sharing the import processing (`import_docs: true`).
+The following diagram shows an example architecture of two {sgw-t} nodes handling the incoming client connections (`import_docs: false`) and two nodes sharing the import processing (`import_docs: true`).
 
 image:workload-isolation.png[]
 
@@ -262,16 +270,16 @@ image:workload-isolation.png[]
 .Next Steps
 ****
 
-* Check out our getting started tutorial for more on how to setup, configure and run {sgw} replications - xref:tutorials:userprofile-sync:userprofile_sync.adoc[Sync tutorial]
+* Check out our getting started tutorial for more on how to setup, configure and run {sgw-t} replications - xref:tutorials:userprofile-sync:userprofile_sync.adoc[Sync tutorial]
 
 * Further reading:
 ** {cbs} documentation on {server-data-xattr-fundamentals--xref}
 
 ** Configuration file references:
 
 *** {enable-sba-config-item} to enable convergence for a given database.
-*** {configuration-schema-database--pfx--db}-import_docs[$dbname.import_docs] to give a particular {sgw} node the role of importing the documents.
-*** {configuration-schema-database--pfx--db}-import_filter[$dbname.import_filter] to select which document(s) to make aware to mobile clients.
+*** {configuration-schema-database--pfx}#import_docs[$dbname.import_docs] to give a particular {sgw-t} node the role of importing the documents.
+*** {configuration-schema-database--pfx}#import_filter[$dbname.import_filter] to select which document(s) to make aware to mobile clients.
 
 ****
 

modules/ROOT/pages/whatsnew.adoc

@@ -44,7 +44,7 @@ With a large number of documents, it may lead to timeouts and out-of-memory cond
 In any sizeable setup, it is recommended that you should instead use the xref:rest_api_public.adoc#tag/Database-Management/operation/get_keyspace-_changes[`GET /{keyspace}/_changes`] operation to get all documents for a user, or the xref:rest_api_public.adoc#tag/Document/operation/post_keyspace-_bulk_docs[`POST /{keyspace}/_bulk_docs`] operation to return any number of documents.
 
 To disable the xref:rest_api_public.adoc#tag/Document/operation/get_keyspace-_all_docs[`GET /{keyspace}/_all_docs`] operation in the Public REST API, set xref:configuration-schema-database.adoc#disable_public_all_docs[`disable_public_all_docs`] to `true` in the database configuration.
-This option is set to `false` by default.
+This option is set to `false` by default; it will be set to `true` by default in a future release.
 
 ==== Interactive Admin Credentials for SG Collect Info