Doc: update the build framework #13537
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Heads up @ru-fu - the "Documentation" label was applied to this issue. |
Update the build environment to match what we have in the current starter pack. Also including some files I previously left out, so we can start using them. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Use the Makefile in the doc/ folder for documentation, and pass through doc commands from the main Makefile. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Not sure why this wasn't caught before ... Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
ru-fu
force-pushed
the
LXD-1111-doc-framework
branch
12 times, most recently
from
f152c85
to
b608fae
Compare
Link to the style guide for more information and include the MyST cheat sheet from the starter pack (which allows copying the syntax). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
Some projects need additional prerequisites. We should handle that in Makefile.sp so it's easier to set up. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
We should really use the reusable workflows, but this is currently not possible since we require some non-standard processing. Therefore, keep the current checks and update them to the latest framework. Also, build the docs first and then run the spellcheck on the docs that are already built (instead of building again). Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>
ru-fu
force-pushed
the
LXD-1111-doc-framework
branch
from
b608fae
to
84ed1fe
Compare
|
This seems to work fine now. A potential problem might be the change of the output directory - the docs were written to We'll still need to move over to using the reusable workflows for the documentation checks. This is currently blocked by the workflows requiring specific target names. I'm preparing a PR to fix that. |
simondeziel
added a commit
to simondeziel/lxd-pkg-snap
that referenced
this pull request
Jun 4, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
tomponline
pushed a commit
to tomponline/lxd-pkg-snap
that referenced
this pull request
Jun 7, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4)
tomponline
pushed a commit
to tomponline/lxd-pkg-snap
that referenced
this pull request
Jun 26, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4)
tomponline
pushed a commit
to tomponline/lxd-pkg-snap
that referenced
this pull request
Jul 11, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4)
simondeziel
added a commit
to simondeziel/lxd-pkg-snap
that referenced
this pull request
Jul 16, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4) Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
simondeziel
added a commit
to simondeziel/lxd-pkg-snap
that referenced
this pull request
Jul 16, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4) Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
simondeziel
added a commit
to simondeziel/lxd-pkg-snap
that referenced
this pull request
Jul 17, 2024
Since canonical/lxd#13537 Signed-off-by: Simon Deziel <simon.deziel@canonical.com> (cherry picked from commit 0dd5da4) Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.