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/rgw: improve diagram caption #50316

Conversation

zdover23
Copy link
Contributor

@zdover23 zdover23 commented Mar 1, 2023

Improve the syntax and semantics of the caption of the diagram "Replication of Object Data Between Zones" in doc/radosgw/multisite.rst.

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@zdover23 zdover23 requested review from a team as code owners March 1, 2023 07:37
@zdover23
Copy link
Contributor Author

zdover23 commented Mar 1, 2023

This PR is a sequel to #50276.

@zdover23 zdover23 force-pushed the wip-doc-2023-03-01-radosgw-multisite-diagram-object-replication-text-revision branch from c508a71 to 51b8a03 Compare March 1, 2023 08:42
Copy link
Contributor

@anthonyeleven anthonyeleven left a comment

Choose a reason for hiding this comment

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

Non-blocking suggestion.

@@ -66,10 +66,13 @@ something like this:

At the top of this diagram, we see two applications (also known as "clients").
The application on the right is both writing and reading data from the Ceph
Cluster, by means of the RADOS Gateway (RGW).
Cluster, by means of the RADOS Gateway (RGW). The application on the left is
only reading data from the Ceph Cluster, by means of an instance of RADOS
Copy link
Contributor

Choose a reason for hiding this comment

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

I might italicize reading to disambiguate the message.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll do that. I appreciate the benefit of your fresh eyes.

Improve the syntax and semantics of the caption of the diagram
"Replication of Object Data Between Zones" in doc/radosgw/multisite.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
@zdover23 zdover23 force-pushed the wip-doc-2023-03-01-radosgw-multisite-diagram-object-replication-text-revision branch from 51b8a03 to e8aa50e Compare March 1, 2023 16:28
@zdover23 zdover23 merged commit 0bd1b34 into ceph:main Mar 1, 2023
3 checks passed
@zdover23
Copy link
Contributor Author

zdover23 commented Mar 1, 2023

#50331 - Quincy backport
#50332 - Pacific backport

zdover23 added a commit to zdover23/ceph that referenced this pull request Mar 5, 2023
Rewrite the third paragraph of the caption to the figure depicting how a
zonegroup works.

Follows ceph#50316.

Signed-off-by: Zac Dover <zac.dover@proton.me>
@zdover23 zdover23 mentioned this pull request Mar 5, 2023
14 tasks
zdover23 added a commit to zdover23/ceph that referenced this pull request Mar 6, 2023
Rewrite the third paragraph of the caption to the figure depicting how a
zonegroup works.

Follows ceph#50316.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 8fa5214)
zdover23 added a commit to zdover23/ceph that referenced this pull request Mar 6, 2023
Rewrite the third paragraph of the caption to the figure depicting how a
zonegroup works.

Follows ceph#50316.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 8fa5214)
zdover23 added a commit to zdover23/ceph that referenced this pull request Mar 6, 2023
Rewrite the third paragraph of the caption to the figure depicting how a
zonegroup works.

Follows ceph#50316.

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 8fa5214)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants