Skip to content

Move single-node tutorial to how-to section#415

Merged
lmlg merged 4 commits into
canonical:mainfrom
skoech:single_node_howto
Sep 24, 2024
Merged

Move single-node tutorial to how-to section#415
lmlg merged 4 commits into
canonical:mainfrom
skoech:single_node_howto

Conversation

@skoech

@skoech skoech commented Sep 10, 2024

Copy link
Copy Markdown
Collaborator

Description

The guide to installing MicroCeph on a single node is currently presented as a tutorial although it is more appropriate as a how-to guide. This change moves it to the how-to guide section of the documentation.

Type of change

  • Documentation update (Doc only change)

Sharon Koech added 2 commits September 10, 2024 19:31
Signed-off-by: Sharon Koech <sharonkoech5147@gmail.com>
Signed-off-by: Sharon Koech <sharonkoech5147@gmail.com>

@evildmp evildmp left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

One small change, with that in place looks good to me.

Comment thread docs/how-to/index.rst Outdated

*********************************************
Installing and initialising MicroCeph cluster
*********************************************

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Okay, definitely much cleaner.

Signed-off-by: Sharon Koech <sharonkoech5147@gmail.com>
@evildmp

evildmp commented Sep 11, 2024

Copy link
Copy Markdown

There is a failing documentation test, because CephFS needs to be in https://github.com/canonical/microceph/blob/main/docs/.wordlist.txt

@skoech

skoech commented Sep 11, 2024

Copy link
Copy Markdown
Collaborator Author

Done.

@skoech skoech added the documentation Improvements or additions to documentation label Sep 19, 2024
…s.rst

Signed-off-by: Sharon Koech <sharon.koech@canonical.com>

@lmlg lmlg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@lmlg lmlg merged commit 30f6c95 into canonical:main Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants