-
Notifications
You must be signed in to change notification settings - Fork 14.2k
SIG Docs quarterly planning, 2018 Q4 (KubeCon Seattle)
This page contains notes from the Kubernetes SIG quarterly planning meeting at KubeCon Seattle 2018.
Quarterly planning meetings are where SIG Docs sets our quarterly priorities.
28 March 2019 (time and agenda TBD)
Meeting notes Below are the notes in Markdown
KubeCon Seattle 2018
SIG Docs planning session
10 December 2018 / 10am-2pm / Kubernetes Contributor Day space
- Steve Perry, Brad Topol, Jared Bhatti, Kaitlyn Barnard, Joe Heck, Shavi Dissinayake, Cody Clark, Dominik Tornow, Jennifer Rondeau, Rajakavitha Kodhandapani, Zach Arnold, Zach Corleissen, Andrew Chen, Tim Fogarty
- Hello and thank you!
What did we accomplish in 2018?
-
Launched the MVP of User Journeys
-
Hugo migration
-
Internationalization
-
Support for Chinese, Japanese and Korean
-
Might have a German translation soon!
-
-
Doc sprints at a variety of conferences
-
Onboarded 4 new release-meisters
-
Onboarded 8+ new approvers
-
Formalizing the PR-wrangler process
-
New contributor guide!
-
Started long term (6+ month) project planning
-
Fundamental modeling concepts
-
Blog migration (Blogger -> Github)
-
New working groups (Tools, API doc generation)
-
Site analytics, SEO audits
What do we need to focus on during 2019?
-
Onboarding new devs
-
Setup --> Getting Started
-
Explaining basic and intermediate concepts better
-
Expanding task documentation
-
Improving/Redoing user journeys
-
-
Improving Docs Process:e
-
Defining/Documenting release docs process
-
Review PR review process
-
-
Better CLI and Admin documentation
-
Release Notes Process
-
Meta information architecture (scope and strategy)
- Content freshness
-
Security Documentation & Bulletins
-
Site UX
-
Accessibility
How do we get there from here?
-
Q1 (Jan-March)
-
Onboarding new devs / admins
-
Define the content plan (Steve Perry)
- Deliverable: Github project w/ list of issues detailing new onboarding content.
-
What is K8s? (overview) (Brad, Andrew)
- Deliverable: Plan out the concepts and content for a new user understanding k8s, meaningful progress on content.
-
Setup --> Getting Started (Jennifer, Chris, Cody)
- Deliverable: Formulate a list of milestones for Chris. Define new list of content.
-
Redoing User Journeys (Andrew)
- Deliverable: Create plan and hand off to another.
-
Admins: set up a cluster, how to secure clusters (Zach A)
- Deliverable: Define a prioritized list of topics that need to be documented for users.
-
-
1.14 release (Jim Angel)
-
Defining/Documenting release docs process (Jim, Jared, Cody)
-
Deliverable: 1.15 handoff complete doc, create release playbook for 1.15 and ongoing releases, doc generation process is documented and works smoothly, & find a home for the content (sig-release vs contrib guide).
-
-
Meta information architecture (scope and strategy) (Zach, Steve)
- Deliverable: Make a decision on Pwittrock's Kubectl Docs, determine integration.
-
Accessibility (Rajakavitha Kodhandapani)
- Deliverable: Make plan with prioritized list of fundamental accessibility issues that need to be addressed.
-
-
Q2
-
Release Notes (Jennifer)
-
1.15 release
- Content audit? Additions to release playbook
-
Meta information architecture (scope and strategy)
- Content freshness and Auditing
-
[Andrew, Dominik] Modeling project overview and updates [Link]
-
Modeling: Can we give new users a consistent MODEL of K8s and how it works?
-
Current models/interviews in progress: API Server, Master Components, Nodes
-
Inside the Kubernetes Scheduler (case study) [Link]
[Jennifer] Release Notes Process / History
-
For 1.14: Check in with the release team (SIG-Release) about the release notes process. There's currently no conversation.
-
For Q2, 1.15: Any changes discussed for 1.14 should be implemented in 1.15.