Skip to content

Conversation

@minaelee
Copy link

Description

The MicroCeph docs set is pulled in as part of the MicroCloud integrated docs set, which allows the user to switch between the MicroCloud, LXD, MicroCeph, and MicroOVN products from a header menu.

For MicroCloud users, some pages of the other docs sets are not relevant (such as installation docs, which MicroCloud handles). This PR adds a note-type annotation to such pages advising users of this, which uses the only Sphinx directive to only show those notes when the page is viewed as part of the MicroCloud integrated docs set. It has no effect on the standalone MicroCeph docs set.

Type of change

Please delete options that are not relevant.

  • Documentation update (Doc only change)

How Has This Been Tested?

I tested manually in local build, both as a standalone docs set and how it's viewed when pulled into a MicroCloud integrated docs set. It behaves as expected: invisible in the standalone, visible in the integrated.

@minaelee minaelee requested a review from skoech April 17, 2025 01:16
@minaelee minaelee marked this pull request as draft April 17, 2025 23:18
Copy link
Collaborator

@skoech skoech left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for doing this, @minaelee.

Just one concern (unrelated to the annotations): on the MicroCeph landing page, there's a misplaced line before the four top statements.

@minaelee minaelee force-pushed the microcloud-integration-annotations branch from e48682f to 97828ea Compare July 27, 2025 00:59
@minaelee
Copy link
Author

LGTM, thanks for doing this, @minaelee.

Just one concern (unrelated to the annotations): on the MicroCeph landing page, there's a misplaced line before the four top statements.

Thanks @skoech! This is ready for re-review; I've updated the annotations to use a custom title ("For MicroCloud users" instead of "Note"), slightly reworded the content, and added inline comments to explain it for other contributors viewing the source.

Do you still see a misplaced line on the landing page? What does the line look like?

@minaelee minaelee requested a review from skoech July 27, 2025 01:04
@minaelee minaelee marked this pull request as ready for review July 27, 2025 19:00
Copy link
Collaborator

@skoech skoech left a comment

Choose a reason for hiding this comment

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

Looks really good, @minaelee! Good idea to specify that the annotation is "For MicroCloud users" to draw their attention, and emphasise that it's not just a general note. I also like that you added an informative note in the landing page regarding installation instructions and instructions for removing cluster members.

Also, I no longer see the misplaced line, thanks. :)

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.

3 participants