Skip to content

doc: fix how html, css is added to MicroCeph (v2-edge) - #1454

Merged
roosterfish merged 1 commit into
canonical:v2-edgefrom
elijahgreenstein:fix-microceph-banner
Jul 13, 2026
Merged

doc: fix how html, css is added to MicroCeph (v2-edge)#1454
roosterfish merged 1 commit into
canonical:v2-edgefrom
elijahgreenstein:fix-microceph-banner

Conversation

@elijahgreenstein

Copy link
Copy Markdown
Contributor

When on the MicroCeph section of the v2-edge docs, the top navigation menu currently only shows the MicroCeph navigation links rather than the integrated docs header.

To fix this, this PR updates the docs Makefile to overwrite the MicroCeph header.html file with the integrated header file in the MicroCloud docs (.sphinx/_integration/microceph.html). Based on this change, this PR also removes an unnecessary mkdir rule from the Makefile and removes unnecessary settings from the add_config.py settings for MicroCeph.

Checklist

@github-actions github-actions Bot added the Documentation Documentation needs updating label Jul 10, 2026
Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>

@roosterfish roosterfish left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks, why do we need this change only in v2-edge but not in main?

@elijahgreenstein

Copy link
Copy Markdown
Contributor Author

The header and footer templates in the latest version of Microceph are in the MicroCeph repo under docs/_templates/. In the version of MicroCeph that we pin to for v2-edge, they are in a different location: docs/.sphinx/_templates/. As a result, we only need to change the destination for the integration header for v2-edge, but not for main.

You can see that, at present, the header is working correctly for latest (main) (https://documentation.ubuntu.com/microcloud/latest/microceph/) but not for v2-edge (https://documentation.ubuntu.com/microcloud/default/microceph/).

@roosterfish

Copy link
Copy Markdown
Contributor

The header and footer templates in the latest version of Microceph are in the MicroCeph repo under docs/_templates/. In the version of MicroCeph that we pin to for v2-edge, they are in a different location: docs/.sphinx/_templates/. As a result, we only need to change the destination for the integration header for v2-edge, but not for main.

You can see that, at present, the header is working correctly for latest (main) (https://documentation.ubuntu.com/microcloud/latest/microceph/) but not for v2-edge (https://documentation.ubuntu.com/microcloud/default/microceph/).

Thanks for clarifying this!

@roosterfish
roosterfish merged commit e016755 into canonical:v2-edge Jul 13, 2026
18 checks passed
@elijahgreenstein
elijahgreenstein deleted the fix-microceph-banner branch July 13, 2026 16:28
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.

2 participants