Skip to content

doc: update how-to, reference landing pages#1348

Merged
roosterfish merged 2 commits into
canonical:mainfrom
elijahgreenstein:restructure-landing
Apr 24, 2026
Merged

doc: update how-to, reference landing pages#1348
roosterfish merged 2 commits into
canonical:mainfrom
elijahgreenstein:restructure-landing

Conversation

@elijahgreenstein
Copy link
Copy Markdown
Contributor

This PR is a further update to the MicroCloud landing pages (How-to guides and Reference), building on PR #1337.

  • Some summaries have been removed when the organization of the section is clear from the TOC titles (for example, "Get support" and "Contribute to MicroCloud")
  • Other summaries have been edited to (1) minimize redundancy with the TOC titles and/or (2) emphasize what MicroCloud, MicroCeph, and MicroOVN make possible for users
  • The reference materials have been reorganized to foreground the Cluster Manager and CLI
  • The how-to guide headers have been edited to consistently begin with action verbs (specifically, changing "Initial setup" to "Set up and deploy")

Checklist

@github-actions github-actions Bot added the Documentation Documentation needs updating label Apr 21, 2026
@elijahgreenstein elijahgreenstein changed the title doc: update how-to, ref landing pages doc: update how-to, reference landing pages Apr 21, 2026
Comment thread doc/how-to/index.md Outdated
Comment thread doc/how-to/index.md Outdated
Comment thread doc/explanation/index.md Outdated
Comment thread doc/how-to/index.md Outdated
Comment thread doc/reference/index.md Outdated
Copy link
Copy Markdown

@minaelee minaelee left a comment

Choose a reason for hiding this comment

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

Thank you!

@roosterfish
Copy link
Copy Markdown
Contributor

Can be rebased.

This commit updates the landing pages for the how-to guides and
reference materials:

- Summaries have been edited for brevity
- Some summaries have been removed due to redundancy with the TOC titles
- The reference materials have been reorganized to foreground the
  Cluster Manager and CLI
- The how-to guide headers have been edited to consistently begin with
  action verbs

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
This commit edits the HTML metadata to clarify that the tutorial, how-to
guide, explanation, and reference landing pages are index pages, not the
actual content.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
@elijahgreenstein
Copy link
Copy Markdown
Contributor Author

elijahgreenstein commented Apr 23, 2026

Thanks, @roosterfish . Should be all set now

@roosterfish roosterfish merged commit 9de0051 into canonical:main Apr 24, 2026
15 checks passed
@elijahgreenstein elijahgreenstein deleted the restructure-landing branch April 24, 2026 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants