[Backport release-1.32] Overhaul docs templating #6020
Conversation
This file contains hidden or 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
twz123
added
documentation
twz123
force-pushed
the
backport-6018-to-release-1.32
branch
2 times, most recently
from
97cefe5 to
fd1c99d
Compare
Allows for deeper integration into the sources and build system,
obtaining values from a single source of truth. This should reduce the
number of search-and-replace actions that typically occur across the
codebase.
Introduce a custom MkDocs macro module to enable more advanced
templating in the documentation. Add the src_var and build_var macros to
make values stored as literal variables or constants in the sources or
variables declared in the build system accessible.
Add the custom ljust filter to maintain the correct table layout when
replacing values of varying lengths.
Update the Makefiles and GitHub workflows to support the custom
module. Replace the KUBERNETES_VERSION environment variable with
build_var('kubernetes_version') and forward the k0s version to
the documentation build. Use the k0s version directly instead
of constructing it from the Kubernetes version in each template
replacement. Use the new macros and filters to replace some previously
hardcoded values.
Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com>
(cherry picked from commit cd3f9e9)
(cherry picked from commit 87a0fb4)
Export PYTHONPATH and K0S_VERSION environment variables in the setup step, so they will be available in subsequent steps. Fixes: cd3f9e9 ("Overhaul docs templating") Fixes: 702ed06 ("Fix docs version updates") Signed-off-by: Tom Wieczorek <twieczorek@mirantis.com> (cherry picked from commit 01a59d1) (cherry picked from commit 622562d)
twz123
force-pushed
the
backport-6018-to-release-1.32
branch
from
fd1c99d to
de89e98
Compare
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.
Backport to
release-1.32:See: