microceph icon indicating copy to clipboard operation
microceph copied to clipboard

Microcloud integration annotations

Open minaelee opened this issue 8 months ago • 1 comments

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.

  • [X] 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 avatar Apr 17 '25 01:04 minaelee