Documentation SIG
summary
Proposal to re-architect the docs into a clear intro → usage → reference flow with the goal of completion within a year, add keyword search and per-page links to GitHub issues plus a simple like/vote path, fix installation guidance (Debian instructions mostly work; Halyard 1.1.52.0 fails due to a Spring Boot upgrade), surface examples and pipeline “hello world” manifests, document CI integrations (GitHub Actions, GitLab CI, Jenkins, Travis), flesh out plugin extension points and storage migration to SQL, and revive try.spinnaker.io as a playground.
AI-written summary · about
chapters (12)
- 0:00Introduction and welcome
- 3:19Current docs challenges
- 9:12Improving documentation structure
- 13:55Key use cases and adoption
- 22:16CI/CD integration options
- 25:01Pipeline documentation gaps
- 29:41Deployment and cloud providers
- 32:31Storage and database best practices
- 36:16Extending Spinnaker with plugins
- 39:45Authentication and security docs
- 43:52Tone and clarity in docs
- 45:14Community collaboration and next steps
related talks
44mPushing documentation (so it doesn't hurt anymore)
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
48mBeyond Words: Crafting User-Friendly Documentation
35mThe practical implementation of Documentation as Code
25mBuilding Docs like Code: Continuous Integration for Documentation
43mUseful and Beautiful Developer Docs and How to Create Them
59mTransforming your Documentation Process
26mKim Crayton - SeattleJS Conference 2017