Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MicroCloud doc integration #372

Merged
merged 9 commits into from
Aug 20, 2024
Merged

Conversation

ru-fu
Copy link
Contributor

@ru-fu ru-fu commented Aug 13, 2024

doc/Makefile.sp comes from the starter pack and should not be
changed. Therefore, we'll need to add our own targets to doc/Makefile.
And that means we must use that file. ;)

Signed-off-by: Ruth Fuchss <[email protected]>
@ru-fu ru-fu force-pushed the LXD-988-doc-integration branch 16 times, most recently from 6388d78 to 4ef75b3 Compare August 14, 2024 16:36
@ru-fu ru-fu marked this pull request as ready for review August 15, 2024 16:37
Copy link
Contributor

@MggMuggins MggMuggins left a comment

Choose a reason for hiding this comment

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

This is really awesome, thanks! Only a few nits from me.

doc/.sphinx/_integration/header.css Show resolved Hide resolved
doc/.sphinx/_integration/lxd.html Show resolved Hide resolved
doc/Makefile Outdated Show resolved Hide resolved
doc/.readthedocs.yaml Show resolved Hide resolved
doc/index.md Outdated Show resolved Hide resolved
Download the other doc sets and build them, integrated with the
MicroCloud docs.
You can still run `make doc-microcloud` to build the single
MicroCloud documentation.

Signed-off-by: Ruth Fuchss <[email protected]>
MggMuggins
MggMuggins previously approved these changes Aug 16, 2024
Copy link
Contributor

@MggMuggins MggMuggins left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

roosterfish
roosterfish previously approved these changes Aug 19, 2024
Copy link
Contributor

@roosterfish roosterfish left a comment

Choose a reason for hiding this comment

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

Looks great, only one small non-blocking remark to the repo cloning.

doc/Makefile Show resolved Hide resolved
doc/.readthedocs.yaml Outdated Show resolved Hide resolved
By default, the workflows use Makefile.sp, but we want them to use
our customised targets.

Signed-off-by: Ruth Fuchss <[email protected]>
Allow specifying the version for each doc set, and make sure to
reset the Git repos to use it.

Signed-off-by: Ruth Fuchss <[email protected]>
@ru-fu ru-fu dismissed stale reviews from roosterfish and MggMuggins via 3c80d2c August 19, 2024 16:08
To let Google know that these are copies of the original doc
sets, add a rel="canonical" link element (see
https://developers.google.com/search/docs/crawling-indexing/consolidate-duplicate-urls ).

This is achieved by setting Sphinx's `html_baseurl` configuration.

Signed-off-by: Ruth Fuchss <[email protected]>
@masnax masnax merged commit 9b476bb into canonical:main Aug 20, 2024
14 of 15 checks passed
@ru-fu ru-fu deleted the LXD-988-doc-integration branch August 20, 2024 15:19
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.

6 participants