Microcloud integration annotations #545
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.