Skip to content

DOC-13437:Folder structuring for sgw #901

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 5, 2025
Merged

DOC-13437:Folder structuring for sgw #901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 85 additions & 85 deletions modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

.Start Here!
// * xref:index.adoc[Quick Links]
* xref:get-started-prepare.adoc[Prepare]
* xref:get-started-install.adoc[Install]
* xref:get-started-verify-install.adoc[Verify]
* 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]

//

Expand All @@ -23,97 +23,97 @@
//

.Configuration
* xref:configuration-overview.adoc[Overview]
* xref:configuration-schema-bootstrap.adoc[Bootstrap]
* xref:configuration-schema-database.adoc[Database]
** xref:scopes-and-collections-config.adoc[Scopes and Collections Configuration for Sync Gateway]
* xref:configuration-schema-db-security.adoc[Database Security]
* xref:configuration-schema-access-control.adoc[Access Control]
* xref:configuration-schema-import-filter.adoc[Import Filter]
* xref:configuration-schema-isgr.adoc[Inter-Sync Gateway Replication]
* xref:configuration-properties-legacy.adoc[Legacy Pre-3.0 Configuration]
* xref:configuration-javascript-functions.adoc[Javascript Functions]
* xref: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:secure-sgw-access.adoc[Secure Access]
* xref:authentication-users.adoc[User Authentication]
* xref:authentication-certs.adoc[TLS Cert Authentication]
* xref:audit-logging.adoc[]
** xref:manage-audit-logs.adoc[]
** xref: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-concepts.adoc[Concepts]
** xref:access-control-model.adoc[Access Control Model]
** xref:channels.adoc[Channels]
** xref:roles.adoc[Roles]
** xref:users.adoc[Users]
* xref:sync-function.adoc[Sync Function]
** xref:sync-function-api.adoc[API Reference]
*** xref:sync-function-api-access-cmd.adoc[access()]
*** xref:sync-function-api-channel-cmd.adoc[channel()]
*** xref:sync-function-api-expiry-cmd.adoc[expiry()]
*** xref:sync-function-api-require-access-cmd.adoc[requireAccess()]
*** xref:sync-function-api-require-admin-cmd.adoc[requireAdmin()]
*** xref:sync-function-api-require-role-cmd.adoc[requireRole()]
*** xref:sync-function-api-require-user-cmd.adoc[requireUser()]
*** xref:sync-function-api-role-cmd.adoc[role()]
*** xref:sync-function-api-throw-cmd.adoc[throw()]
* xref:access-control-how.adoc[How-to]
** xref:access-control-how-create-users.adoc[Create Users]
** xref:access-control-how-create-roles.adoc[Create Roles]
** xref:access-control-how-assign-users-to-roles.adoc[Assign User to Role]
** xref:access-control-how-control-document-access.adoc[Control Document Access]
** xref:access-control-how-verify-access.adoc[Verify Access]
** xref:access-control-how-use-xattrs-for-access-grants.adoc[Use XATTRS for Access Grants]
* xref: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-api/sync-function.adoc[Sync Function]
** xref:access-control/sync-function-api/sync-function-api.adoc[API Reference]
*** xref:access-control/sync-function-api/sync-function-api-access-cmd.adoc[access()]
*** xref:access-control/sync-function-api/sync-function-api-channel-cmd.adoc[channel()]
*** xref:access-control/sync-function-api/sync-function-api-expiry-cmd.adoc[expiry()]
*** xref:access-control/sync-function-api/sync-function-api-require-access-cmd.adoc[requireAccess()]
*** xref:access-control/sync-function-api/sync-function-api-require-admin-cmd.adoc[requireAdmin()]
*** xref:access-control/sync-function-api/sync-function-api-require-role-cmd.adoc[requireRole()]
*** xref:access-control/sync-function-api/sync-function-api-require-user-cmd.adoc[requireUser()]
*** xref:access-control/sync-function-api/sync-function-api-role-cmd.adoc[role()]
*** xref:access-control/sync-function-api/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-access.adoc[Secure Access]
* xref:rest-api-admin.adoc[Admin 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-metrics.adoc[Metrics REST API]
* xref:rest-api/rest-api-metrics.adoc[Metrics REST API]
** xref:rest_api_metrics_static.adoc[Metrics API Reference]
* xref:rest-api.adoc[Public REST API]
* xref:rest-api/rest-api.adoc[Public REST API]
** xref:rest_api_public_static.adoc[Public API Reference]
* xref:rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference]
* xref:rest-api/rest-api-access-rbac-roles.adoc[RBAC Role - Endpoint Cross-Reference]

.Sync
* xref:sync-with-couchbase-server.adoc[Sync with Server]
* xref: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-inter-syncgateway-overview.adoc[Overview]
** xref:sync-inter-syncgateway-run.adoc[Initialize]
** xref:sync-inter-syncgateway-manage.adoc[Manage]
** xref:sync-inter-syncgateway-monitor.adoc[Monitor]
** xref:sync-inter-syncgateway-conflict-resolution.adoc[Inter Syncgateway Conflict Resolution]
* xref:delta-sync.adoc[Delta Sync]
* xref: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:revisions.adoc[Revisions]
* xref:managing-tombstones.adoc[Tombstones]
* xref:resync.adoc[Resync]
* xref:stats-monitoring.adoc[Stats Monitoring]
** xref:stats-monitoring-json.adoc[]
** xref:stats-monitoring-prometheus.adoc[]
* xref:database-offline.adoc[Database Offline]
* xref:logging.adoc[Logging]
** xref: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:deployment.adoc[Overview]
* xref:command-line-options.adoc[Command Line Options]
* xref:load-balancer.adoc[Load Balancer]
* xref:os-level-tuning.adoc[OS Level Tuning]
* xref:webhooks.adoc[Webhooks]
* xref:changes-feed.adoc[Changes Feed]
* 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:stats-prometheus.adoc[Prometheus Feed]
* xref:indexing.adoc[Indexing]
** xref:index-partitions.adoc[]
* xref:setting-up-dr-cluster.adoc[Disaster Recovery]
* 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]

//

Expand All @@ -122,18 +122,18 @@
//

.Use Kubernetes
* xref: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-buckets.adoc[Buckets]
* xref:server-compatibility-collections.adoc[Collections]
* xref:server-compatibility-eventing.adoc[Eventing]
* xref:server-compatibility-transactions.adoc[Transactions]
* xref:server-compatibility-xdcr.adoc[XDCR]
* xref:xdcr-active-active-eventing.adoc[XDCR Active-Active and Eventing]
* xref: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:release-notes.adoc[Release Notes]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/_partials/_define_component_attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ ifdef::releasetag[:tag: -{releasetag}]
:fn_post270: footnote:fnpost270[Since 2.7]
:fnref_post270: footnote:fnpost270[]

:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]]
:fn_legacy: footnote:fnlegacy[For Pre-3.0 legacy configuration see: xref:configuration/configuration-properties-legacy.adoc[Configuration Properties (legacy Pre3.0)]]

:fnref_legacy: footnote:fnlegacy[]

Expand Down
Loading