/k8s-diagrams

Diagram concepts for making Kubernetes concepts easy to understand

Kubernetes Graphing Group

The Kubernetes Graphing Group formed out of a desire to make the Kubernetes documentation more easily accessible. We aim to establish conistency by developing graphical guidelines, to visualize concepts by constructing architecture diagrams, and to incorporate these diagrams and images into the open source documentation.

Vision

Facilitate the Kubernetes learning experience by making concepts easier to understand in the Kubernetes body of knowledge.

Mission

Make a high value and high exposure contribution to the Kuberenetes open source documentation set by creating a visual language for concept diagrams.

Status

M1 Initiation

Milestone Overview · Task Overview · Get Involved

Progress

Progress Milestone
M1 Initiation
M2 Prioritize concepts
M3 Discuss possible representations for concepts & post sketches
M4 Establish basic visual guidelines
M5 Design visually consistent vector (i.e. SVG) symbols

Prospective contributors

Get involved

We are looking for like-minded individuals to contribute to this effort! If you have:

  • Technical knowledge of Kubernetes
  • Experience with making diagrams or similar visual elements
  • Creativity to brainstorm and evaluate the usefulness of diagram schematics

then join us by finding a contribution opportunity.

A: How do I find a contribution opportunity?

  1. Check if there are issues with the recruiting tag

  2. Check for interesting tasks by browsing

B: How is project work organized?

The project is guided by our vision statement.

All work is geared towards completing the mission statement.

General communication is done in our Communication center to not unnecessary clutter the project documentation ;)

  1. Milestones
    • Key points to accomplish our mission
  2. Tasks
    • Single actionable tasks which have to be done to reach a milestone
  3. Single Task
    • Assignees are responsible for task completion (dedicated contributors)
    • Initial comment is a wiki aggregating the overall important information of the task
    • Continuing comments are used as a news stream to represent status of task
  4. Communication center
    • Collaboration tool to chat and exchange information where needed

C: How can I learn about working in GitHub?

Get up and running in no time with these 2 Youtube guides from the GuitHub team :)