-
Notifications
You must be signed in to change notification settings - Fork 15.1k
SIG Docs Summit: 2018, Portland
- We set values and agreed on "themes" for 2018
- Next summit is in Seattle, December 2018
- @bradamant3
- @chenopis
- @eliza411 (visiting from Digital Ocean)
- @jaredbhatti (facilitator)
- @mistyhacks
- @rrm
- @steveperry-53
- @tallt0m
- @zacharysarah (facilitator)
Refer to #8116.
@jaredbhatti led an exercise where we shared gifts and hooks: what we bring to the SIG Docs community; and what we need to be (and stay) engaged.
Originally scheduled as Vision, Values, and Mission. Due to time constraints, we voted to discuss only one; the majority chose values.
We defined values as why and how we pursue the work of SIG Docs. We reached consensus that the values for Kubernetes SIG Docs are:
- Simple
- Open
- Equitable
- Inclusive
- Excellent
- Voltron1
1: Voltron is a pop-culture reference to a benevolent entity formed when a team combines, whose power is greater than the sum of its parts.
We reached consensus that SIG Docs will prioritize work in the following themes for the remainder of 2018:
-
Better onboarding for docs contributors
- Onboard new contributors quickly and efficiently in order to increase SIG Docs' ability to create and maintain top-quality docs for Kubernetes
-
Better onboarding for new Kubernetes users
- Improve Getting Started and Setup docs to make it as easy as possible to adopt Kubernetes.
-
Measuring docs success with analytics and user testing
- Adopt metrics for page and site quality.
-
Improving docs processes
- Increase PR throughput and reduce barriers to contribution.
We responded to three questions:
"I wish SIG Docs would..."
| Start | Stop | Continue |
|---|---|---|
| Defining different roles for sig docs contributors | Don't leave shared work for one person to do | Developing maintainer guidelines |
| Training contribs on best practices | Stop mixing bugs with project management tasks in the issues trackers | Train new docs leads for releases |
| Learn what motivates contributors | Stop putting PRs on hold | Keep doing summits |
| Train others on how to write docs | Stop capitalizing key K8s terms | Keep showing respect for contributor time by saying no compassionately |
| Sharing more grunt work | Stop supporting third-party docs and info | Commitment to open and welcoming PR management |
| Start communicating diverse ways to be involved | Simplify contribution guidelines for PRs | |
| Doing UX studies | Be excellent to work with | |
| Do UX studies to understand real world usage | Be open and outspoken | |
| Start user testing | Small working groups to collaborate and implement changes | |
| Reach out systematically to other SIGs | Well organized weekly meetings | |
| Use GitHub projects more | Recorded weekly meetings | |
| Start organizing tasks into programs | Sharing what we learn about writing | |
| Share what we learn about processes | Sharing our little corners of knowledge with the larger SIG | |
| Share what we learn about measuring quality and effectiveness | Give presentations related to docs at conferences | |
| More visibility into changes that affect us | Organizing, editing, writing concepts | |
| Share side conversations when they start | Continue site cleanup | |
| Give presentations related to docs at conferences | Write and organize task topics | |
| Use more diagrams and define a visual language to convey architecture | ||
| Better code sandboxing | ||
| More robust beginner experiences than the standard nginx hello world | ||
| Start including code samples on ref pages |
Reference: K8s start stop continue, by @tallt0m
-
We agreed to host SIG Docs Summits twice yearly, and to peg them to KubeCon/CloudNativeCon dates and locations.
The next summit will be in Seattle in December 2018.
-
We will consider extending summits to two days to allow time for retrospectives.