-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
🌱 Use official plantuml image for diagrams #9328
🌱 Use official plantuml image for diagrams #9328
Conversation
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.
/area documentation
/lgtm |
LGTM label has been added. Git tree hash: 8fd84b7d193a97900577ed7614569f911733cda1
|
@@ -571,7 +574,18 @@ generate-metrics-config: $(ENVSUBST_BIN) ## Generate ./hack/observability/kube-s | |||
|
|||
.PHONY: generate-diagrams | |||
generate-diagrams: ## Generate diagrams for *.plantuml files |
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.
Not sure if it's a good idea, but wondering if we should run this in CI with a corresponding verify target
(I assume the resulting png files are reproducible)
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.
We're doing a basic verification - that the images don't disappear - using the link checker - I don't know if we really need something more advanced, but can look into it and take it as a follow up.
One issue is we also host a couple of svg images which are not generated by plantuml AFAIK
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.
I leave it up to you. I'm fine with just this PR
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.
We have a bunch of images that are not generated from plantuml - list is below:
I'm not going to add a verify target in this PR - but I'll open an issue mentioning the current issues. I think this was supposed to be followed up from #7033 but was missed.
deleted: docs/book/src/images/describe-cluster-disable-grouping.png
deleted: docs/book/src/images/describe-cluster-echo.png
deleted: docs/book/src/images/describe-cluster-how-grouping-works.png
deleted: docs/book/src/images/describe-cluster-show-conditions.png
deleted: docs/book/src/images/describe-cluster.png
deleted: docs/book/src/images/introduction.png
deleted: docs/book/src/images/runtime-sdk-lifecycle-hooks.png
deleted: docs/proposals/images/capi-provider-operator/fig3.png
deleted: docs/proposals/images/capi-provider-operator/fig4.png
deleted: docs/proposals/images/clusterctl-redesign/components.png
deleted: docs/proposals/images/conditions/cluster-provision-workflow.png
deleted: docs/proposals/images/conditions/upgrade-workflow.png
deleted: docs/proposals/images/externally-managed-cluster-infrastructure/infrastructure.png
deleted: docs/proposals/images/in-place-propagation/current-state.png
deleted: docs/proposals/images/in-place-propagation/optional-changes.png
deleted: docs/proposals/images/in-place-propagation/proposed-changes.png
deleted: docs/proposals/images/ipam-integration/consumption.png
deleted: docs/proposals/images/ipam-integration/sequence.png
deleted: docs/proposals/images/machine-states-preboot/Figure2.png
deleted: docs/proposals/images/runtime-hooks/runtime-hooks.png
deleted: docs/proposals/images/runtime-sdk/overview.png
deleted: docs/proposals/images/runtime-sdk/swagger-ui.png
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.
Thx! Just a few questions |
Signed-off-by: killianmuldoon <kmuldoon@vmware.com>
2f8ee84
to
15ed517
Compare
Thx! /lgtm |
LGTM label has been added. Git tree hash: 10e1acf76b2689d1ed6b9243234d957d3c9b8bd9
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sbueringer The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/cherry-pick release-1.5 |
/cherry-pick release-1.4 |
Cherry picks seem worthwhile to me to update very old dependency versions in supported branches. |
@killianmuldoon: new pull request created: #9332 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
@killianmuldoon: new pull request created: #9333 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Use the official plantuml image from plantuml/plantuml https://hub.docker.com/r/plantuml/plantuml to build the images for the book and proposals.
This lets us get rid of a docker file with several pinned versions, and the Makefile in the docs folder.