Skip to content

Conversation

@iamfortune
Copy link
Contributor

@iamfortune iamfortune commented Nov 13, 2025

Docs Issue: DOC-13682

PR to update the db offline for SGW

Preview URLs:

You will need the Docs Team credentials on Confluence.

Copy link
Contributor

@sarahlwelton sarahlwelton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see the information architecture of this page sorted before you merge this. I don't think we're quite hitting the mark right now.

I'd recommend for Take Database Offline/Online:

  • Some introductory information, that includes the "use cases" content that you have further down the page, try to better incorporate the state diagram into the explanation.
  • A heading for "Automatically Taking a Database Offline" - provide the context and link to the REST API request to bring the database back online.
  • A heading for "Take a Database Offline Manually" - with a clear procedure, prerequisites, and considerations. You can divide this further with subheadings for Persistent vs. NonPersistent config.
  • A heading for "Take a Database Online Manually" - with a clear procedure, prerequisites, and considerations. You can divide this further with subheadings for Persistent vs. NonPersistent config.

For the Resync topic, try to single source the procedure and link to your "Taking a Database Online/Offline" information instead of writing it out again.

I'd also recommend using proper headings for the procedures so they appear in the on-page TOC.

Please, try to use the page templates more when constructing these pages and pay attention to how you're structuring your information: https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/1989443613/Documentation+Templates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants