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

reef: doc/radosgw: Improve language and formatting in config-ref.rst #52835

Merged

Conversation

zdover23
Copy link
Contributor

@zdover23 zdover23 commented Aug 6, 2023

The "Topic persistency settings" section includes convoluted and incomplete sentences so attempt to improve the language. The section lacks context so add a link to the relevant documentation about Notifications.

The "Garbage Collection settings" note includes a sentence that looks incomplete so try to improve the language.

Don't capitalize "Ops" in "RGW Ops" especially when the same sentence talks about "op queue" with lower case "o".

Also improve formatting: indentation of a note and wrap several very long lines.

Signed-off-by: Ville Ojamo 14869000+bluikko@users.noreply.github.com
(cherry picked from commit 9dd8677)

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

The "Topic persistency settings" section includes convoluted
and incomplete sentences so attempt to improve the
language. The section lacks context so add a link to the
relevant documentation about Notifications.

The "Garbage Collection settings" note includes a sentence
that looks incomplete so try to improve the language.

Don't capitalize "Ops" in "RGW Ops" especially when the
same sentence talks about "op queue" with lower case "o".

Also improve formatting: indentation of a note and wrap
several very long lines.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
(cherry picked from commit 9dd8677)
@zdover23 zdover23 force-pushed the wip-doc-2023-08-06-backport-52824-to-reef branch from 1cf4a51 to 559e703 Compare August 9, 2023 00:18
@zdover23 zdover23 merged commit d9dfe5d into ceph:reef Aug 9, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants