-
Notifications
You must be signed in to change notification settings - Fork 188
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.
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
doc(self-managed): improve multiregion self-managed readability #4223
Conversation
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
295e707
to
aa06902
Compare
@leiicamundi Let me know when this PR is ready for a TW review 👍 |
@leiicamundi could you rebase the branch, so your change is isolated to what you wanted to restructure. |
@Langleu I'll do it today |
aa06902
to
63f1740
Compare
Hey @mesellings, @Langleu, this PR is now rebased onto main and ready to be reviewed :) |
Thanks @leiicamundi I'll do this for you now 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@leiicamundi I have reviewed and made commits directly to the branch for readability, writing standards (for example, we do not use "e.g.", but rather "for example,", and general grammar.
Great work - happy to approve 👍
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, cool suggestion.
Not the biggest fan of the detail column as it doesn't align well on the wording. Also some rows are just repeating the same information or completely out of context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @Langleu, thanks for your review. I've modified the identified parts, let me know what you think about the changes.
cc @theburi if you want to do other changes on this doc, feel free to use this PR if you want (I'll not update it anymore today and it will be easier to deal with potential conflicts with #4278)
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
docs/self-managed/operational-guides/multi-region/dual-region-ops.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the quick changes 🙇.
Looks good from my side 🚀
🧹 Preview environment for this PR has been torn down. |
Description
This PR aims to improve readability of the self-managed multi-region documentation by adding tables and refactoring some parts.
When should this change go live?
It should not be merged until #4205 is merged.
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).