Release/3.3 module refactoring #912
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
also mv partials to ROOT/partials
release-notes, logging, sync-function
There was a problem hiding this comment.
Pull Request Overview
This pull request implements a comprehensive module refactoring for the Sync Gateway documentation site to support version 3.3. The main purpose is to restructure the content organization by moving pages from the ROOT module to specialized modules while updating all cross-references accordingly.
Key changes include:
- Moving documentation pages from ROOT module to specialized modules (sync, deploy, manage, security, etc.)
- Updating all internal cross-references to use explicit module prefixes (e.g.,
ROOT:,sync:,deploy:) - Adding page aliases to maintain backward compatibility with old URLs
- Creating new module-specific API reference pages for REST APIs
Reviewed Changes
Copilot reviewed 155 out of 220 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| preview/release/3.3-module-refactoring.yml | Configuration file for the 3.3 module refactoring preview |
| modules/use-kubernetes/pages/deploy-cluster-to-kubernetes.adoc | Updates cross-references to use ROOT module prefix for partials and aliases |
| modules/sync/pages/*.adoc | Multiple sync-related pages with updated cross-references and ROOT module prefixes |
| modules/start-here/pages/*.adoc | Getting started pages with updated cross-references to ROOT module |
| modules/server-compatibility/pages/*.adoc | Server compatibility pages with updated cross-references |
| modules/security/pages/*.adoc | Security documentation with updated cross-references and aliases |
| modules/rest-api/pages/*.adoc | New REST API reference pages and updated cross-references |
| modules/product-notes/pages/*.adoc | Product notes with updated cross-references |
| modules/manage/pages/*.adoc | Management documentation with updated cross-references |
| modules/deploy/pages/*.adoc | Deployment documentation with updated cross-references |
| modules/configuration/pages/*.adoc | Configuration documentation with updated cross-references |
| modules/access-control/pages/*.adoc | Access control documentation with updated cross-references |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| = Sync Function | ||
| :page-aliases: sync-function.adoc | ||
| :page-aliases: ROOT:sync-function.adoc | ||
| :page-aliases: ROOT:sync-function.adoc, ROOT:sync-function-overview.adoc, sync-function-overview.adoc |
There was a problem hiding this comment.
Duplicate alias 'ROOT:sync-function.adoc' appears in the page-aliases directive. The first alias should be sufficient.
Suggested change
| :page-aliases: ROOT:sync-function.adoc, ROOT:sync-function-overview.adoc, sync-function-overview.adoc | |
| :page-aliases: ROOT:sync-function-overview.adoc, sync-function-overview.adoc |
omits sgw 2.7 as that link to Star Channel is currently broken on prod also.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview: https://preview.docs-test.couchbase.com/docs-sync-gateway-release/3.3-module-refactoring/