search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.36k stars 14.11k forks source link

Standardizing Kubernetes Architectural Diagrams - a.k.a Diagram Creation Guide #19811

Open dkypuros opened 4 years ago

dkypuros commented 4 years ago

Summary of Feature Request Kubernetes documentation needs better diagrams. We need a standard set of Kubernetes icons and clear guidelines for content creators to make their own architectural diagrams.

Brief Overview of Project During a K8s SIG-Docs meeting (November 2019), several SIG Docs members commented on the lack of consistency between Kubernetes icons and diagrams on the official Kubernetes Docs website (see “What is Kubernetes”, and “Kubernetes Components”).

Do you want to help? Are you interested in helping? Can you join a Zoom call to talk through the effort and help build some icons? Feel free to message me on slack @david.kypuros. We're not ready for a PR, just looking for people to assist with this mini-project.

Please Review for more background

dkypuros commented 4 years ago

/assign @dkypuros

dkypuros commented 4 years ago

Artwork Reference (commenting enabled):

Kubernetes Architectural Diagram Guide - Draft v1

Icons Kubernetes Architectural Diagram Guide - Draft v1

Istio-Diagram-Guide - Inspiration from CNCF Friends

Fale commented 4 years ago

Hi, This is a very interesting topic for me, so thanks for your work!

  1. The kube-controller-manager icon is not very clear for me.
  2. There are 2 different icons for kube-controller-manager, but I think one of the two should be called clud-controller-manager. I think that both icons are not very clear, as for 0.
  3. In Icons Kubernetes Architectural Diagram Guide there alignment problems in the bottom right area
  4. The istio-diagram-guide seems to have some access restrictions. Can those be lifted?

Thanks again for the great work :-)

dkypuros commented 4 years ago

Hi, This is a very interesting topic for me, so thanks for your work!

  1. The kube-controller-manager icon is not very clear for me.
  2. There are c for kube-controller-manager, but I think one of the two should be called clud-controller-manager. I think that both icons are not very clear, as for 0.
  3. In Icons Kubernetes Architectural Diagram Guide there alignment problems in the bottom right area
  4. The istio-diagram-guide seems to have some access restrictions. Can those be lifted?

Thanks again for the great work :-)

Awesome feedback!

  1. Fixed it. Still not 100% happy with my funky "controller" icons though :-) I welcome any graphical help. All I could think of was "Atari Controllers" ;-)

  2. Fixed the "2 different icons". Agree, those two icons aren't clear.

  3. Fixed.

  4. To get access requires a few steps. I just copied the google draw file, and dropped it here docs.google.com/drawings...

PS Fale: Ping me on slack if you want edit access. I hang out in the SIG-DOCS channel.

celestehorgan commented 4 years ago

I don't have real feedback for you yet, but wanted to bring up that this section exists in the k8s community repo.

dkypuros commented 4 years ago

I don't have real feedback for you yet, but wanted to bring up that this section exists in the k8s community repo.

I'm taking a closer look at this section...

tengqm commented 4 years ago

/language en

sftim commented 4 years ago

A similar issue: #21763

fejta-bot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

sftim commented 3 years ago

Still very valuable IMO /remove-lifecycle stale

sftim commented 3 years ago

If we add this, let's have https://www.kubernetes.dev/docs/ link to it.

sftim commented 3 years ago

/triage accepted

fejta-bot commented 3 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

fejta-bot commented 3 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community. /lifecycle rotten

sftim commented 3 years ago

/remove-lifecycle rotten /lifecycle frozen

mehabhalodiya commented 1 year ago

@dkypuros I don't see any updates; so unassigning you. Please feel free to assign, if you come back here again and are willing to work on 🙂 /unassign @dkypuros

dkypuros commented 1 year ago

Thanks. I'll consider it.

On Sat, Jan 21, 2023 at 6:12 AM Meha Bhalodiya @.***> wrote:

@dkypuros https://github.com/dkypuros I don't see any updates; so unassigning you. Please feel free to assign, if you come back here again and are willing to work on 🙂 /unassign @dkypuros https://github.com/dkypuros

— Reply to this email directly, view it on GitHub https://github.com/kubernetes/website/issues/19811#issuecomment-1399239906, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACY2UBQLICWSMFNVZEB5V3WTPHBXANCNFSM4LSCKNTA . You are receiving this because you were mentioned.Message ID: @.***>

k8s-triage-robot commented 5 months ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

divya-mohan0209 commented 2 months ago

This is still relevant IMO /triage accepted