Skip to content

Conversation

@ggray-cb
Copy link
Contributor

@ggray-cb ggray-cb commented Sep 3, 2024

Main rational behind this change is to explicitly state that you can restore a backup taken from a bucket using one storage backend (i.e. Couchstore) and restore it to a bucket using another backend (i.e. Magma). This is to hopefully get the AI to respond correctly when asked about this.

For a preview of the changes, see:

Because I was there, I took some time to review the restore section of the documentation and experimenting with the backup system. Then I fixed a bunch more stuff:

  • The description of the Auto-remove Collections field on the Restore dialog was wrong. (this caused the AI to also describe this field incorrectly, so kinda in harmony with the original intent of the bug. Updated with info from @safianalicb).
  • Added mention that you can restore a backup to a different cluster (which wasn't mentioned in the original documentation).
  • Moved the section on the Advanced Restore Options out of the step-by-step procedure to its own subhead to improve readability of the procedure.
  • Updated outdated screenshots.
  • Edited for clarity and documentation standards.

Also, I found that VS Code is limited to reporting 1000 or so issues at a time. This limits our text linting tool (Vale). This page has more than that many standards violations in it, so I fixed enough issues in other sections of the page to bring the issue count down to where Vale could check my edits. There's a lot more to do in this page (and it probably needs to be restructured into several separate pages). I've created DOC-12508 to track further fixes for this page.

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.
@ggray-cb ggray-cb merged commit d992571 into release/7.6 Sep 10, 2024
@ggray-cb ggray-cb deleted the DOC-12453_restore_different_storage_engines branch September 10, 2024 20:17
RayOffiah pushed a commit that referenced this pull request Nov 2, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
simon-dew pushed a commit that referenced this pull request Nov 12, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
simon-dew pushed a commit that referenced this pull request Nov 12, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
RayOffiah pushed a commit that referenced this pull request Dec 9, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
RayOffiah pushed a commit that referenced this pull request Dec 9, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
rao-shwe pushed a commit that referenced this pull request Dec 10, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
rao-shwe pushed a commit that referenced this pull request Dec 10, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
simon-dew pushed a commit that referenced this pull request Dec 10, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
simon-dew pushed a commit that referenced this pull request Dec 10, 2024
… Collections) (#3680)

* Current progress, mainly on updating the restore backup.

* In progress checkin:

* Added statement that the
* Heavily edited the Restore Backups section to bring it up to standards.
* Corrected several errors in the documentation.
* Had to do more editing to earlier parts of the topic to reduce the number of Vale errors so I could get my sections written. There were so many issues in the page before my updates that VS Code stopped checking.

* A few more low-hanging-fruit fixes to make Vale happy. Plenty more to fix, but I want to wrap this up.
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.

2 participants