Skip to content

doc: Add bootstrap context to tutorial#805

Open
zeel2104 wants to merge 1 commit into
canonical:mainfrom
zeel2104:docs-bootstrap-context
Open

doc: Add bootstrap context to tutorial#805
zeel2104 wants to merge 1 commit into
canonical:mainfrom
zeel2104:docs-bootstrap-context

Conversation

@zeel2104

@zeel2104 zeel2104 commented Jul 16, 2026

Copy link
Copy Markdown

Description

Adds brief context to the “Initialise your cluster” section of the MicroCeph tutorial, explaining what bootstrapping does at a high level before the user runs microceph cluster bootstrap.

This helps new users understand that bootstrap creates the initial cluster configuration and keys, registers the first node, and starts the core Ceph services.

Fixes: canonical/open-documentation-academy#352 (comment)

Type of change

  • Documentation update (change to documentation only)

How has this been tested?

  • Ran git diff --check successfully.
  • Attempted a local Sphinx build with sphinx-build --fail-on-warning --keep-going -b dirhtml . _build -c . -d _dev\.doctrees -D llms_txt_enabled=0, but it could not complete because the local environment is missing the canonical_sphinx Python package.

Contributor checklist

Please check that you have:

  • self-reviewed the code in this PR
  • added code comments, particularly in less straightforward areas
  • checked and added or updated relevant documentation
  • added or updated HTML meta descriptions for any new or modified documentation pages (see #643)
  • verified that page title and headings accurately represent page content for new or modified documentation pages
  • checked and added or updated relevant release notes
  • added tests to verify effectiveness of this change

Signed-off-by: Zeel <desaizeel2128@gmail.com>
@johnramsden
johnramsden requested a review from skoech July 16, 2026 20:46
@skoech

skoech commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Thank you for your prompt contribution, @zeel2104!

Since it's your first time contributing, you will need to sign the Canonical Contributor Licence Agreement (CLA). If you already have, it may take some time (up to a day) to reflect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants