canonical/open-documentation-academy

MicroCeph: Add brief context to the bootstrap action in the tutorial

オープン

#352 opened on 2026/07/16

 (2 件のコメント) (0 件のリアクション) (1 人の担当者)Python (99 件のフォーク)auto 404
clagood first issuesize 1tutorial

Repository metrics

Stars
 (119 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Mentor

The mentor for this issue is @skoech. They are the technical author for Ceph.

Background

In the MicroCeph tutorial, we guide a user through deploying a Ceph cluster and consuming object storage. Bootstrapping the cluster is a fundamental step, but it is quite vague: "..bootstrap your new Ceph storage cluster." doesn't say anything about what this means. While the term "bootstrap" is a common industry term, it may be foreign to new users. Replacing it with a simpler term may not be effective, but shedding some light on its meaning and significance would create a better learning experience for our new users. It would be useful to make the user understand what cluster bootstrap is, and what it does.

Prerequisites

This is an ideal task for a new contributor who is interested in learning about Ceph, and how to write good documentation. Prior knowledge of Git, Sphinx and rST is not required; this is an opportunity to learn all these. Prior knowledge of cloud storage is a good-to-have, but not necessary.

Learnings

Upon completion of this task, you will have learned/gained the following:

  • Writing a good tutorial, using the Diátaxis framework
  • User focus in documentation
  • A basic understanding of how MicroCeph (and Ceph) works
  • Working with the GitHub pull request workflow

Task

Add brief context about the bootstrap action in the Initialise your cluster section of the tutorial

[! IMPORTANT]:

Claim the task here, but please leave any questions and comments under the duplicate issue in the MicroCeph repository to get help and feedback from the Ceph team. Raise your pull request in the same repository.

If it’s your first time contributing to a Canonical project, you will need to sign the Canonical Contributor Licence Agreement (CLA). Read more about why in our contributor guide.

Scope

Since this is a tutorial, the description should be brief and accessible. Do not overwhelm the user with overly complex background details.

Outcome

The additional context provided for the bootstrap will improve the learning experience for our new users and increase their confidence in their next steps, and why they are making them.

Resources

Thank you in advance for your contribution!

コントリビューターガイド