Release/3.3 module refactoring (#912)

* Step 1 refactor: move ROOT/pages/subdirectories to ROOT/module

also mv partials to ROOT/partials

* first batch of xref rewrites

* pass 2 xref rewrite

* manual xref change

* xref ROOT links

* manual refactor

* ROOT:partial

* manual update 2 files duplicate page-aliases

* update page-aliases

* image: replacement

* define_page_index

* ROOT files in index

* manual tweaks

* preview with highlight-broken-links

* rename yml

* manual fixes

release-notes, logging, sync-function

* more manual fixes

* more manual fixes

* unresolved includes

* update preview

omits sgw 2.7 as that link to Star Channel is currently broken on prod also.

Author: osfameron

.gitignore

@@ -93,7 +93,6 @@ $RECYCLE.BIN/
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
-[Rr]elease/
 [Rr]eleases/
 x64/
 x86/
@@ -416,4 +415,4 @@ modules/ROOT/assets/attachments/.DS_Store
 
 #OpenAPI Generator files
 .openapi-generator
-.openapi-generator-ignore
+.openapi-generator-ignore

modules/ROOT/nav.adoc

@@ -1,148 +1,148 @@
 //
 
-* xref:introduction.adoc[Introduction]
+* xref:ROOT:introduction.adoc[Introduction]
 
 //
 
 //
 
-* xref:whatsnew.adoc[pass:q,a[*_New in {release}_*]]
+* xref:ROOT:whatsnew.adoc[pass:q,a[*_New in {release}_*]]
 
 //
 
 .Start Here!
-// * xref:index.adoc[Quick Links]
-* xref:start-here/get-started-prepare.adoc[Prepare]
-* xref:start-here/get-started-install.adoc[Install]
-* xref:start-here/get-started-verify-install.adoc[Verify]
+// * xref:ROOT:index.adoc[Quick Links]
+* xref:start-here:get-started-prepare.adoc[Prepare]
+* xref:start-here:get-started-install.adoc[Install]
+* xref:start-here:get-started-verify-install.adoc[Verify]
 
 //
 
-* xref:data-modeling.adoc[Data Modeling]
+* xref:ROOT:data-modeling.adoc[Data Modeling]
 
 //
 
 .Configuration
-  * xref:configuration/configuration-overview.adoc[Overview]
-  * xref:configuration/configuration-schema-bootstrap.adoc[Bootstrap]
-  * xref:configuration/configuration-schema-database.adoc[Database]
-    ** xref:configuration/scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway]
-  * xref:configuration/configuration-schema-db-security.adoc[Database Security]
-  * xref:configuration/configuration-schema-access-control.adoc[Access Control]
-  * xref:configuration/configuration-schema-import-filter.adoc[Import Filter]
-  * xref:configuration/configuration-schema-isgr.adoc[Inter-Sync Gateway Replication]
-  * xref:configuration/configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration]
-  * xref:configuration/configuration-javascript-functions.adoc[Javascript Functions]
-  * xref:configuration/configuration-environment-variables.adoc[Environment Variables]
+  * xref:configuration:configuration-overview.adoc[Overview]
+  * xref:configuration:configuration-schema-bootstrap.adoc[Bootstrap]
+  * xref:configuration:configuration-schema-database.adoc[Database]
+    ** xref:configuration:scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway]
+  * xref:configuration:configuration-schema-db-security.adoc[Database Security]
+  * xref:configuration:configuration-schema-access-control.adoc[Access Control]
+  * xref:configuration:configuration-schema-import-filter.adoc[Import Filter]
+  * xref:configuration:configuration-schema-isgr.adoc[Inter-Sync Gateway Replication]
+  * xref:configuration:configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration]
+  * xref:configuration:configuration-javascript-functions.adoc[Javascript Functions]
+  * xref:configuration:configuration-environment-variables.adoc[Environment Variables]
 
 .Security
-  * xref:security/secure-sgw-access.adoc[Secure Access]
-  * xref:security/authentication-users.adoc[User Authentication]
-  * xref:security/authentication-certs.adoc[TLS Cert Authentication]
-  * xref:security/audit-logging.adoc[]
-    ** xref:security/manage-audit-logs.adoc[]
-    ** xref:security/audit-log-events.adoc[]
+  * xref:security:secure-sgw-access.adoc[Secure Access]
+  * xref:security:authentication-users.adoc[User Authentication]
+  * xref:security:authentication-certs.adoc[TLS Cert Authentication]
+  * xref:security:audit-logging.adoc[]
+    ** xref:security:manage-audit-logs.adoc[]
+    ** xref:security:audit-log-events.adoc[]
 
 .Access Control
-  * xref:access-control/access-control-concepts.adoc[Concepts]
-    ** xref:access-control/access-control-model.adoc[Access Control Model]
-    ** xref:access-control/channels.adoc[Channels]
-    ** xref:access-control/roles.adoc[Roles]
-    ** xref:access-control/users.adoc[Users]
-  * xref:access-control/sync-function/sync-function.adoc[Sync Function]
-    ** xref:access-control/sync-function/sync-function-api.adoc[API Reference]
-      *** xref:access-control/sync-function/sync-function-api-access-cmd.adoc[access()]
-      *** xref:access-control/sync-function/sync-function-api-channel-cmd.adoc[channel()]
-      *** xref:access-control/sync-function/sync-function-api-expiry-cmd.adoc[expiry()]
-      *** xref:access-control/sync-function/sync-function-api-require-access-cmd.adoc[requireAccess()]
-      *** xref:access-control/sync-function/sync-function-api-require-admin-cmd.adoc[requireAdmin()]
-      *** xref:access-control/sync-function/sync-function-api-require-role-cmd.adoc[requireRole()]
-      *** xref:access-control/sync-function/sync-function-api-require-user-cmd.adoc[requireUser()]
-      *** xref:access-control/sync-function/sync-function-api-role-cmd.adoc[role()]
-      *** xref:access-control/sync-function/sync-function-api-throw-cmd.adoc[throw()]
-  * xref:access-control/access-control-how.adoc[How-to]
-    ** xref:access-control/access-control-how-create-users.adoc[Create Users]
-    ** xref:access-control/access-control-how-create-roles.adoc[Create Roles]
-    ** xref:access-control/access-control-how-assign-users-to-roles.adoc[Assign User to Role]
-    ** xref:access-control/access-control-how-control-document-access.adoc[Control Document Access]
-    ** xref:access-control/access-control-how-verify-access.adoc[Verify Access]
-    ** xref:access-control/access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants]
-  * xref:access-control/auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation]
+  * xref:access-control:access-control-concepts.adoc[Concepts]
+    ** xref:access-control:access-control-model.adoc[Access Control Model]
+    ** xref:access-control:channels.adoc[Channels]
+    ** xref:access-control:roles.adoc[Roles]
+    ** xref:access-control:users.adoc[Users]
+  * xref:access-control:sync-function/sync-function.adoc[Sync Function]
+    ** xref:access-control:sync-function/sync-function-api.adoc[API Reference]
+      *** xref:access-control:sync-function/sync-function-api-access-cmd.adoc[access()]
+      *** xref:access-control:sync-function/sync-function-api-channel-cmd.adoc[channel()]
+      *** xref:access-control:sync-function/sync-function-api-expiry-cmd.adoc[expiry()]
+      *** xref:access-control:sync-function/sync-function-api-require-access-cmd.adoc[requireAccess()]
+      *** xref:access-control:sync-function/sync-function-api-require-admin-cmd.adoc[requireAdmin()]
+      *** xref:access-control:sync-function/sync-function-api-require-role-cmd.adoc[requireRole()]
+      *** xref:access-control:sync-function/sync-function-api-require-user-cmd.adoc[requireUser()]
+      *** xref:access-control:sync-function/sync-function-api-role-cmd.adoc[role()]
+      *** xref:access-control:sync-function/sync-function-api-throw-cmd.adoc[throw()]
+  * xref:access-control:access-control-how.adoc[How-to]
+    ** xref:access-control:access-control-how-create-users.adoc[Create Users]
+    ** xref:access-control:access-control-how-create-roles.adoc[Create Roles]
+    ** xref:access-control:access-control-how-assign-users-to-roles.adoc[Assign User to Role]
+    ** xref:access-control:access-control-how-control-document-access.adoc[Control Document Access]
+    ** xref:access-control:access-control-how-verify-access.adoc[Verify Access]
+    ** xref:access-control:access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants]
+  * xref:access-control:auto-purge-channel-access-revocation.adoc[Auto-Purge Channel Access Revocation]
 
 .REST API
-  * xref:rest-api/rest-api-access.adoc[Secure Access]
-  * xref:rest-api/rest-api-admin.adoc[Admin REST API]
-    ** xref:rest_api_admin_static.adoc[Admin API Reference]
-  * xref:rest-api/rest-api-metrics.adoc[Metrics REST API]
-    ** xref:rest_api_metrics_static.adoc[Metrics API Reference]
-  * xref:rest-api/rest-api.adoc[Public REST API]
-    ** xref:rest_api_public_static.adoc[Public API Reference]
-  * xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference]
+  * xref:rest-api:rest-api-access.adoc[Secure Access]
+  * xref:rest-api:rest-api-admin.adoc[Admin REST API]
+    ** xref:ROOT:rest_api_admin_static.adoc[Admin API Reference]
+  * xref:rest-api:rest-api-metrics.adoc[Metrics REST API]
+    ** xref:ROOT:rest_api_metrics_static.adoc[Metrics API Reference]
+  * xref:rest-api:rest-api.adoc[Public REST API]
+    ** xref:ROOT:rest_api_public_static.adoc[Public API Reference]
+  * xref:rest-api:rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference]
 
 .Sync
-  * xref:sync/sync-with-couchbase-server.adoc[Sync with Server]
-  * xref:sync/sync-using-app.adoc[Sync with Application]
+  * xref:sync:sync-with-couchbase-server.adoc[Sync with Server]
+  * xref:sync:sync-using-app.adoc[Sync with Application]
   * Inter-Sync Gateway Replication
-    ** xref:sync/sync-inter-syncgateway-overview.adoc[Overview]
-    ** xref:sync/sync-inter-syncgateway-run.adoc[Initialize]
-    ** xref:sync/sync-inter-syncgateway-manage.adoc[Manage]
-    ** xref:sync/sync-inter-syncgateway-monitor.adoc[Monitor]
-    ** xref:sync/sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution]
-  * xref:sync/delta-sync.adoc[Delta Sync]
-  * xref:sync/import-processing.adoc[Import Processing]
+    ** xref:sync:sync-inter-syncgateway-overview.adoc[Overview]
+    ** xref:sync:sync-inter-syncgateway-run.adoc[Initialize]
+    ** xref:sync:sync-inter-syncgateway-manage.adoc[Manage]
+    ** xref:sync:sync-inter-syncgateway-monitor.adoc[Monitor]
+    ** xref:sync:sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution]
+  * xref:sync:delta-sync.adoc[Delta Sync]
+  * xref:sync:import-processing.adoc[Import Processing]
 
 .Manage
-  * xref:manage/revisions.adoc[Revisions]
-  * xref:manage/managing-tombstones.adoc[Tombstones]
-  * xref:manage/resync.adoc[Resync]
-  * xref:manage/stats-monitoring.adoc[Stats Monitoring]
-  ** xref:manage/stats-monitoring-json.adoc[]
-  ** xref:manage/stats-monitoring-prometheus.adoc[]
-  * xref:manage/database-offline.adoc[Database Offline]
-  * xref:manage/logging.adoc[Logging]
-    ** xref:manage/sgcollect-info.adoc[SG Collect Info]
+  * xref:manage:revisions.adoc[Revisions]
+  * xref:manage:managing-tombstones.adoc[Tombstones]
+  * xref:manage:resync.adoc[Resync]
+  * xref:manage:stats-monitoring.adoc[Stats Monitoring]
+  ** xref:manage:stats-monitoring-json.adoc[]
+  ** xref:manage:stats-monitoring-prometheus.adoc[]
+  * xref:manage:database-offline.adoc[Database Offline]
+  * xref:manage:logging.adoc[Logging]
+    ** xref:manage:sgcollect-info.adoc[SG Collect Info]
 
 .Deploy
-  * xref:deploy/deployment.adoc[Overview]
-  * xref:deploy/command-line-options.adoc[Command Line Options]
-  * xref:deploy/load-balancer.adoc[Load Balancer]
-  * xref:deploy/os-level-tuning.adoc[OS Level Tuning]
-  * xref:deploy/webhooks.adoc[Webhooks]
-  * xref:deploy/changes-feed.adoc[Changes Feed]
-// * xref:integrating-external-stores.adoc[External Stores]
-  * xref:deploy/stats-prometheus.adoc[Prometheus Feed]
-  * xref:deploy/indexing.adoc[Indexing]
-    ** xref:deploy/index-partitions.adoc[]
-  * xref:deploy/setting-up-dr-cluster.adoc[Disaster Recovery]
+  * xref:deploy:deployment.adoc[Overview]
+  * xref:deploy:command-line-options.adoc[Command Line Options]
+  * xref:deploy:load-balancer.adoc[Load Balancer]
+  * xref:deploy:os-level-tuning.adoc[OS Level Tuning]
+  * xref:deploy:webhooks.adoc[Webhooks]
+  * xref:deploy:changes-feed.adoc[Changes Feed]
+// * xref:ROOT:integrating-external-stores.adoc[External Stores]
+  * xref:deploy:stats-prometheus.adoc[Prometheus Feed]
+  * xref:deploy:indexing.adoc[Indexing]
+    ** xref:deploy:index-partitions.adoc[]
+  * xref:deploy:setting-up-dr-cluster.adoc[Disaster Recovery]
 
 //
 
-  * xref:upgrading.adoc[Upgrade]
+  * xref:ROOT:upgrading.adoc[Upgrade]
 
 //
 
 .Use Kubernetes
-  * xref:use-kubernetes/deploy-cluster-to-kubernetes.adoc[Deploy]
+  * xref:use-kubernetes:deploy-cluster-to-kubernetes.adoc[Deploy]
   * xref:operator:ROOT:tutorial-sync-gateway-manage.adoc[Manage a Sync Gateway Cluster]
   * xref:operator:ROOT:tutorial-sync-gateway-clients.adoc[Expose Sync Gateway to Couchbase Lite clients]
 
 .Server Compatibility
-  * xref:server-compatibility/server-compatibility-buckets.adoc[Buckets]
-  * xref:server-compatibility/server-compatibility-collections.adoc[Collections]
-  * xref:server-compatibility/server-compatibility-eventing.adoc[Eventing]
-  * xref:server-compatibility/server-compatibility-transactions.adoc[Transactions]
-  * xref:server-compatibility/server-compatibility-xdcr.adoc[XDCR]
-  * xref:server-compatibility/xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing]
-  * xref:server-compatibility/server-compatibility-backups.adoc[Backup and Restore]
+  * xref:server-compatibility:server-compatibility-buckets.adoc[Buckets]
+  * xref:server-compatibility:server-compatibility-collections.adoc[Collections]
+  * xref:server-compatibility:server-compatibility-eventing.adoc[Eventing]
+  * xref:server-compatibility:server-compatibility-transactions.adoc[Transactions]
+  * xref:server-compatibility:server-compatibility-xdcr.adoc[XDCR]
+  * xref:server-compatibility:xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing]
+  * xref:server-compatibility:server-compatibility-backups.adoc[Backup and Restore]
 
 .Product Notes
-  * xref:product-notes/release-notes.adoc[Release Notes]
-  * xref:product-notes/supported-environments.adoc[Supported Environments]
-  * xref:product-notes/compatibility.adoc[Compatibility Matrix]
+  * xref:product-notes:release-notes.adoc[Release Notes]
+  * xref:product-notes:supported-environments.adoc[Supported Environments]
+  * xref:product-notes:compatibility.adoc[Compatibility Matrix]
 
 
 // list divider
 
-  * xref:glossary.adoc[Glossary]
+  * xref:ROOT:glossary.adoc[Glossary]
 
 //

modules/ROOT/pages/_partials/howto/how-to-sync-function-api.adoc

@@ -25,12 +25,12 @@ ifdef::prerelease[:page-status: {prerelease}]
 :idprefix:
 :idseparator: -
 
-include::partial$_set_page_context.adoc[]
+include::ROOT:partial$_set_page_context.adoc[]
 
 :param-abstract!:
 :param-related: {conflict-resolution--xref}  |  {configuration-schema-bootstrap--xref}
 :topic-group: Sync
-include::partial$_show_page_header_block.adoc[]
+include::ROOT:partial$_show_page_header_block.adoc[]
 
 Conflicts are automatically resolved footnote:[Since Couchbase Lite 2.0].
 The functionality aims to simplify the default behavior of conflict handling and save disk space (conflicting revisions are no longer be stored in the database).
@@ -44,6 +44,6 @@ xref:couchbase-lite:objc:learn/objc-conflict.adoc[Objective-C]
 
 For conflict resolution on 1.x clients -- see : {xref-sgw-pg-resolving-conflicts-legacy}.
 
-include::partial$block-related-content-sync.adoc[]
+include::ROOT:partial$block-related-content-sync.adoc[]
 
 // END -- PAGE -- conflict-resolution.adoc

modules/ROOT/pages/_partials/stats-schema.adoc

@@ -4,7 +4,7 @@ ifdef::show_edition[:page-edition: {release}]
 ifdef::prerelease[:page-status: {prerelease}]
 :page-role:  -toc
 
-include::partial$_define_component_attributes.adoc[]
+include::ROOT:partial$_define_component_attributes.adoc[]
 
 
 [abstract]

modules/ROOT/pages/conflict-resolution.adoc

@@ -5,7 +5,7 @@ ifdef::prerelease[:page-status: {prerelease}]
 :description: pass:q[_Couchbase Sync Gateway's_ data model; for secure cloud-to-edge synchronization of enterprise data.]
 
 
-include::partial$_set_page_context.adoc[]
+include::ROOT:partial$_set_page_context.adoc[]
 
 // BEGIN -- Page Attributes
 :xref-sdk-nodejs-pg-start: xref:nodejs-sdk:hello-world:start-using-sdk.adoc[Node.js Server SDK]
@@ -15,7 +15,7 @@ include::partial$_set_page_context.adoc[]
 // BEGIN -- Page Heading
 :param-abstract!:
 :param-related:  {revisions--xref} | {managing-tombstones--xref}
-include::partial$_show_page_header_block.adoc[]
+include::ROOT:partial$_show_page_header_block.adoc[]
 // END -- Page Heading
 
 == Introduction
@@ -120,5 +120,5 @@ Its main purpose is to enable the replicator to determine which data to sync and
 Each document change is assigned a unique revision ID. The IDs of past revisions are available. The content of past revisions may be available if the revision was created locally and the database has not yet been compacted.
 
 // BEGIN -- Page Footer
-include::partial$block-related-content-data.adoc[]
+include::ROOT:partial$block-related-content-data.adoc[]
 // END -- Page Footer