-
Notifications
You must be signed in to change notification settings - Fork 47
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
Conversation
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]>
6388d78
to
4ef75b3
Compare
There was a problem hiding this 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.
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]>
d7d4ce2
to
7f5a354
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks!
There was a problem hiding this 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.
Signed-off-by: Ruth Fuchss <[email protected]>
By default, the workflows use Makefile.sp, but we want them to use our customised targets. Signed-off-by: Ruth Fuchss <[email protected]>
Signed-off-by: Ruth Fuchss <[email protected]>
Signed-off-by: Ruth Fuchss <[email protected]>
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]>
7f5a354
to
3c80d2c
Compare
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]>
See https://docs.google.com/document/d/1mSGNMG2J58b494bdSuGvN_UeNgTt5MLk_Z8fV2G2K44/edit?usp=sharing for an explanation.