Skip to content

Conversation

@Braundo
Copy link
Contributor

@Braundo Braundo commented Oct 27, 2025

Updating several diagrams for clarity...

  1. Replace the architectural diagram (https://kubernetes.io/docs/concepts/architecture/) with the same one from the components page as it covers the same components and concepts, just with different styled diagrams.
  2. The Pods image here is confusing. (https://kubernetes.io/docs/concepts/workloads/pods/), this diagram (https://kubernetes.io/images/docs/pod.svg).
  3. Added a simple sidecar diagram to accompany the YAML (https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/)
  4. Switched from a linked Mermaid diagram to a clearer diagram (https://kubernetes.io/docs/concepts/services-networking/ingress/).
  5. Switched from a linked Mermaid diagram to a clearer diagram (https://kubernetes.io/docs/concepts/services-networking/ingress/#simple-fanout)
  6. Switched from a linked Mermaid diagram to a clearer diagram (https://kubernetes.io/docs/concepts/services-networking/ingress/#name-based-virtual-hosting)
  7. Controlling access diagram is confusing and looks outdated. (https://kubernetes.io/docs/concepts/security/controlling-access/)
  8. Change from Mermaid to SVG diagram for better clarity (https://kubernetes.io/docs/concepts/cluster-administration/node-autoscaling/)

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign lmktfy for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Oct 27, 2025
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 27, 2025
@netlify
Copy link

netlify bot commented Oct 27, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit b338433
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6901377da3620500092c34e7
😎 Deploy Preview https://deploy-preview-52980--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Braundo Braundo marked this pull request as draft October 27, 2025 16:37
@Braundo Braundo changed the title updating several diagrams for clarity DRAFT: updating several diagrams for clarity Oct 27, 2025
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 27, 2025
@Braundo Braundo marked this pull request as ready for review October 27, 2025 16:57
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 27, 2025
@k8s-ci-robot k8s-ci-robot requested a review from lmktfy October 27, 2025 16:57
@Braundo Braundo changed the title DRAFT: updating several diagrams for clarity updating several diagrams for clarity Oct 27, 2025
Copy link
Member

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Thanks. The new files belong with the English content, though. New diagram content shouldn't go inside static.

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 28, 2025
@Braundo Braundo requested a review from lmktfy October 28, 2025 18:45
@Braundo
Copy link
Contributor Author

Braundo commented Oct 28, 2025

I think I got them all 😄

Copy link
Member

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Once this is all looking OK and previews how you expect it, please squash the commits in this PR.

@Braundo Braundo force-pushed the main branch 2 times, most recently from 43849d4 to e43429d Compare October 28, 2025 20:42
@Braundo Braundo marked this pull request as draft October 28, 2025 20:43
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2025
@Braundo Braundo marked this pull request as ready for review October 28, 2025 20:55
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2025
@Braundo Braundo marked this pull request as draft October 28, 2025 21:10
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2025
- Add/update diagrams for networking, security, workloads, and cluster administration topics
- Add descriptive alt text and explanatory captions
- Standardize all image paths to site-relative /images/docs/ URLs
- Ensure diagrams are published under static/images/docs for preview and production
@Braundo
Copy link
Contributor Author

Braundo commented Oct 28, 2025

Thanks for raising the point about images in static ... I agree that keeping images in content/en/... is important for localization.

Right now each of these diagrams does live under content/en/docs/images/ for the English source of truth. But I also added copies under static/images/docs/ because without that, the new diagrams weren't being published at /images/docs/... in the Netlify preview (and they 404'd when referenced from the docs pages). That meant the figures rendered with captions but the images themselves were broken.

I’m definitely happy to follow the preferred pattern here. If there’s an existing mount or publishing step we should be using so that new images from content/en/docs/images/ get served at /images/docs/... without needing them in static/, I can update this PR to do that instead.

@Braundo Braundo marked this pull request as ready for review October 28, 2025 21:40
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 28, 2025
@Braundo Braundo requested a review from lmktfy October 28, 2025 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants