Conversation
Signed-off-by: Minae Lee <minae.lee@canonical.com>
e48682f to
97828ea
Compare
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? |
There was a problem hiding this comment.
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. :)
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 theonlySphinx 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.
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.