Skip to content
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

Merged
merged 15 commits into from
Sep 10, 2024

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Aug 30, 2024

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.

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@leiicamundi leiicamundi changed the title doc: improve multiregion self-managed readability doc(self-managed): improve multiregion self-managed readability Aug 30, 2024
Copy link
Contributor

github-actions bot commented Aug 30, 2024

👋 🤖 🤔 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/.

  • docs/self-managed/concepts/multi-region/dual-region.md
  • docs/self-managed/operational-guides/multi-region/dual-region-ops.md

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.

@leiicamundi leiicamundi requested a review from Langleu August 30, 2024 13:20
@leiicamundi leiicamundi self-assigned this Aug 30, 2024
@leiicamundi leiicamundi added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed 8.6.0-alpha5 September 2024 alpha release labels Aug 30, 2024
@leiicamundi leiicamundi force-pushed the feature/improve-multiregion-readbility branch from 295e707 to aa06902 Compare September 2, 2024 14:40
@mesellings
Copy link
Contributor

@leiicamundi Let me know when this PR is ready for a TW review 👍

@Langleu
Copy link
Member

Langleu commented Sep 9, 2024

@leiicamundi could you rebase the branch, so your change is isolated to what you wanted to restructure.

@leiicamundi
Copy link
Contributor Author

@Langleu I'll do it today

@leiicamundi leiicamundi force-pushed the feature/improve-multiregion-readbility branch from aa06902 to 63f1740 Compare September 9, 2024 09:39
@leiicamundi leiicamundi marked this pull request as ready for review September 9, 2024 09:59
@leiicamundi
Copy link
Contributor Author

Hey @mesellings, @Langleu, this PR is now rebased onto main and ready to be reviewed :)

@mesellings mesellings added the deploy Stand up a temporary docs site with this PR label Sep 9, 2024
@mesellings
Copy link
Contributor

Thanks @leiicamundi I'll do this for you now 👍

@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 10:23 Destroyed
mesellings
mesellings previously approved these changes Sep 9, 2024
Copy link
Contributor

@mesellings mesellings left a 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 👍

@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 11:15 Destroyed
Copy link
Member

@Langleu Langleu left a 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.

@github-actions github-actions bot temporarily deployed to camunda-docs September 9, 2024 13:58 Destroyed
@Langleu Langleu mentioned this pull request Sep 10, 2024
6 tasks
Copy link
Contributor Author

@leiicamundi leiicamundi left a 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)

@github-actions github-actions bot temporarily deployed to camunda-docs September 10, 2024 09:23 Destroyed
Langleu
Langleu previously approved these changes Sep 10, 2024
Copy link
Member

@Langleu Langleu left a 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 🚀

@github-actions github-actions bot temporarily deployed to camunda-docs September 10, 2024 11:51 Destroyed
@leiicamundi leiicamundi merged commit 768e3e0 into main Sep 10, 2024
7 checks passed
@leiicamundi leiicamundi deleted the feature/improve-multiregion-readbility branch September 10, 2024 12:23
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha5 September 2024 alpha release component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants