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/glossary: improve "ceph" term #48819

Merged
merged 1 commit into from Nov 10, 2022

Conversation

zdover23
Copy link
Contributor

@zdover23 zdover23 commented Nov 9, 2022

Define "ceph" in glossary.rst.

Signed-off-by: Zac Dover zac.dover@gmail.com

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

Define "ceph" in glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
@zdover23 zdover23 requested a review from a team as a code owner November 9, 2022 22:41
@@ -15,6 +15,9 @@
Ceph's default and recommended storage back end.

Ceph
Ceph is a distributed network storage and file system with
distributed metadata management and POSIX semantics.
Copy link
Contributor

Choose a reason for hiding this comment

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

@zdover23 - It would be nice if this could be spelled out a little more to help beginners and outsiders find their bearings.

Copy link
Contributor Author

@zdover23 zdover23 Nov 10, 2022

Choose a reason for hiding this comment

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

@colemitchell: Maybe it would be better if it said "Ceph is a distributed network storage system. It offers block storage, object storage, and file storage. Ceph also provides metadata management, and POSIX semantics."

The text here (in the commit, not in the paragraph above in this comment) was taken verbatim from the "Architecture" document in the argonaut release branch of the git repo (that means "the documentation for the first official release of Ceph").

I'll send an email to the developer list, asking for a better and more current definition of Ceph. For the time being, though, I'm going to merge this PR so that we can close another gap in the glossary.

I take your point, though. "distributed network storage and file system" is a phrase that does not scan at all, as far as I can surmise, for people who don't already know what these things are.

@zdover23 zdover23 merged commit 1cdcfcc into ceph:main Nov 10, 2022
@zdover23
Copy link
Contributor Author

#48820 - Quincy backport
#48821 - Pacific backport

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants