diff options
Diffstat (limited to 'sig-docs')
| -rw-r--r-- | sig-docs/README.md | 72 | ||||
| -rw-r--r-- | sig-docs/blog-subproject/README.md | 56 | ||||
| -rw-r--r-- | sig-docs/survey/2019SIGDocsSurveyRaw.ods | bin | 0 -> 43891 bytes | |||
| -rw-r--r-- | sig-docs/survey/2019SIGDocsSurveyResultsCharts.pdf | bin | 0 -> 150974 bytes | |||
| -rw-r--r-- | sig-docs/survey/2019SeptSurvey.md | 140 |
5 files changed, 203 insertions, 65 deletions
diff --git a/sig-docs/README.md b/sig-docs/README.md index 2195ea14..2c60e230 100644 --- a/sig-docs/README.md +++ b/sig-docs/README.md @@ -16,6 +16,9 @@ The [charter](charter.md) defines the scope and governance of the Docs Special I * APAC SIG Meeting: [Wednesdays at 02:00 UTC](https://docs.google.com/document/d/1zg6By77SGg90EVUrhDIhopjZlSDg2jCebU-Ks9cYx0w/edit) (monthly - fourth Wednesday every month). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=02:00&tz=UTC). * [Meeting notes and Agenda](https://docs.google.com/document/d/1Ds87eRiNZeXwRBEbFr6Z7ukjbTow5RQcNZLaSvWWQsE/edit). * [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8). +* Korean Team Meeting: [Thursdays at 13:00 UTC](https://docs.google.com/document/d/1h5sMhBpPB5unJmBAS7KzDiPs-_eFQOu5o4UyHwMtFCA/edit) (biweekly). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=13:00&tz=UTC). + * [Meeting notes and Agenda](https://docs.google.com/document/d/1h5sMhBpPB5unJmBAS7KzDiPs-_eFQOu5o4UyHwMtFCA/edit). + * [Meeting recordings](https://www.youtube.com/playlist?list=PLAOP7m08QDCWZ7RwGca6cU4vzrOMw3ht7). * Regular SIG Meeting: [Tuesdays at 17:30 UTC](https://docs.google.com/document/d/1zg6By77SGg90EVUrhDIhopjZlSDg2jCebU-Ks9cYx0w/edit) (weekly - except fourth Tuesday every month). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=17:30&tz=UTC). * [Meeting notes and Agenda](https://docs.google.com/document/d/1Ds87eRiNZeXwRBEbFr6Z7ukjbTow5RQcNZLaSvWWQsE/edit). * [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8). @@ -25,53 +28,48 @@ The [charter](charter.md) defines the scope and governance of the Docs Special I ### Chairs The Chairs of the SIG run operations and processes governing the SIG. -* Jennifer Rondeau (**[@bradamant3](https://github.com/bradamant3)**), Stripe -* Jared Bhatti (**[@jaredbhatti](https://github.com/jaredbhatti)**), Google +* Jennifer Rondeau (**[@Bradamant3](https://github.com/Bradamant3)**), Stripe +* Jim Angel (**[@jimangel](https://github.com/jimangel)**), General Motors * Zach Corleissen (**[@zacharysarah](https://github.com/zacharysarah)**), Linux Foundation ## Emeritus Leads * Andrew Chen (**[@chenopis](https://github.com/chenopis)**), Google +* Jared Bhatti (**[@jaredbhatti](https://github.com/jaredbhatti)**), Google ## Contact -* [Slack](https://kubernetes.slack.com/messages/sig-docs) -* [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) -* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2Fdocs) +- Slack: [#sig-docs](https://kubernetes.slack.com/messages/sig-docs) +- [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) +- [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2Fdocs) +- GitHub Teams: + - [@kubernetes/kubernetes-blog](https://github.com/orgs/kubernetes/teams/kubernetes-blog) - Kubernetes blog maintainers + - [@kubernetes/sig-docs-de-owners](https://github.com/orgs/kubernetes/teams/sig-docs-de-owners) - German language content + - [@kubernetes/sig-docs-en-owners](https://github.com/orgs/kubernetes/teams/sig-docs-en-owners) - English content (default) + - [@kubernetes/sig-docs-es-owners](https://github.com/orgs/kubernetes/teams/sig-docs-es-owners) - Spanish language content + - [@kubernetes/sig-docs-fr-owners](https://github.com/orgs/kubernetes/teams/sig-docs-fr-owners) - French language content + - [@kubernetes/sig-docs-id-owners](https://github.com/orgs/kubernetes/teams/sig-docs-id-owners) - Indonesian language content + - [@kubernetes/sig-docs-it-owners](https://github.com/orgs/kubernetes/teams/sig-docs-it-owners) - Italian language content + - [@kubernetes/sig-docs-ja-owners](https://github.com/orgs/kubernetes/teams/sig-docs-ja-owners) - Japanese language content + - [@kubernetes/sig-docs-ko-owners](https://github.com/orgs/kubernetes/teams/sig-docs-ko-owners) - Korean language content + - [@kubernetes/sig-docs-maintainers](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers) - Documentation maintainers + - [@kubernetes/sig-docs-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews) - Documentation PR reviews + - [@kubernetes/sig-docs-pt-owners](https://github.com/orgs/kubernetes/teams/sig-docs-pt-owners) - Portuguese language content + - [@kubernetes/sig-docs-zh-owners](https://github.com/orgs/kubernetes/teams/sig-docs-zh-owners) - Chinese language content ## Subprojects -The following subprojects are owned by sig-docs: -- **kubernetes-blog** - - Owners: - - https://raw.githubusercontent.com/kubernetes/website/master/content/en/blog/OWNERS -- **reference-docs** - - Owners: - - https://raw.githubusercontent.com/kubernetes-incubator/reference-docs/master/OWNERS -- **website** - - Owners: - - https://raw.githubusercontent.com/kubernetes/website/master/OWNERS - -## GitHub Teams - -The below teams can be mentioned on issues and PRs in order to get attention from the right people. -Note that the links to display team membership will only work if you are a member of the org. - -| Team Name | Details | Description | -| --------- |:-------:| ----------- | -| @kubernetes/kubernetes-blog | [link](https://github.com/orgs/kubernetes/teams/kubernetes-blog) | Kubernetes blog maintainers | -| @kubernetes/sig-docs-de-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-de-owners) | German language content | -| @kubernetes/sig-docs-en-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-en-owners) | English content (default) | -| @kubernetes/sig-docs-es-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-es-owners) | Spanish language content | -| @kubernetes/sig-docs-fr-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-fr-owners) | French language content | -| @kubernetes/sig-docs-id-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-id-owners) | Indonesian language content | -| @kubernetes/sig-docs-it-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-it-owners) | Italian language content | -| @kubernetes/sig-docs-ja-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-ja-owners) | Japanese language content | -| @kubernetes/sig-docs-ko-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-ko-owners) | Korean language content | -| @kubernetes/sig-docs-maintainers | [link](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers) | Documentation maintainers | -| @kubernetes/sig-docs-pr-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews) | Documentation PR reviews | -| @kubernetes/sig-docs-pt-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-pt-owners) | Portuguese language content | -| @kubernetes/sig-docs-zh-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-zh-owners) | Chinese language content | - +The following [subprojects][subproject-definition] are owned by sig-docs: +### kubernetes-blog +- **Owners:** + - https://raw.githubusercontent.com/kubernetes/website/master/content/en/blog/OWNERS +### reference-docs +- **Owners:** + - https://raw.githubusercontent.com/kubernetes-incubator/reference-docs/master/OWNERS +### website +- **Owners:** + - https://raw.githubusercontent.com/kubernetes/website/master/OWNERS + +[subproject-definition]: https://github.com/kubernetes/community/blob/master/governance.md#subprojects <!-- BEGIN CUSTOM CONTENT --> ## Goals * Discuss documentation and docs issues for kubernetes.io diff --git a/sig-docs/blog-subproject/README.md b/sig-docs/blog-subproject/README.md index 953f4d03..6978ed1e 100644 --- a/sig-docs/blog-subproject/README.md +++ b/sig-docs/blog-subproject/README.md @@ -2,28 +2,28 @@ The Kubernetes Blog Subproject is owned by [SIG-Docs](https://github.com/kubernetes/community/tree/master/sig-docs) and run by the [Editorial Team](#leadership). -This section covers documentation, processes, and roles for the Kubernetes blog. +This section covers documentation, processes, and roles for the [Kubernetes blog](https://kubernetes.io/blog/). ## Meetings -Regular Blog Meeting: TBD (biweekly). +Regular Blog Meeting: Tuesdays at 18:30 UTC (biweekly). [Convert Your Timezone](http://www.thetimezoneconverter.com/?t=18:30&tz=UTC) -* Meeting notes and Agenda -* Meeting recording +- [Meeting notes and Agenda](https://docs.google.com/document/d/1W5MKkaQGd3YKKZINzj1tJAQbql5R_Y4KAHlFNsJ44Bc/edit?usp=sharing) +- [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8) ## Leadership -* **Editorial Leads:** [Kaitlyn Barnard](https://github.com/kbarnard10), [Zach Corleissen](https://github.com/zacharysarah) (shadow) -* **Technical Editors:** [Bob Killen](https://github.com/mrbobbytables) -* **Copy Editors:** [Alex Handy](https://github.com/vonguard), [Cody Clark](https://github.com/cody-clark) -* **Blog Community Managers:** [Jorge Castro](https://github.com/castrojo), [Paris Pittman](https://github.com/parispittman) (shadow) +- **Editorial Leads:** [Kaitlyn Barnard](https://github.com/kbarnard10), [Zach Corleissen](https://github.com/zacharysarah) (shadow) +- **Technical Editors:** [Bob Killen](https://github.com/mrbobbytables), [Taylor Dolezal](https://github.com/onlydole) (shadow) +- **Copy Editors:** [Alex Handy](https://github.com/vonguard), [Cody Clark](https://github.com/cody-clark) +- **Blog Community Managers:** [Jorge Castro](https://github.com/castrojo), [Paris Pittman](https://github.com/parispittman) (shadow) ## Contact -* Slack: #kubernetes-docs-blog -* Mailing List: [blog@kubernetes.io](mailto:blog@kubernetes.io) -* Open Community Issues/PRs: area/blog label -* GitHub Team: @kubernetes/sig-docs-blog-reviews +- Slack: [#kubernetes-docs-blog](https://kubernetes.slack.com/messages/CJDHVD54J) +- Mailing List: [blog@kubernetes.io](mailto:blog@kubernetes.io) +- Open Community Issues/PRs: [`is:open repo:kubernetes/website label:area/blog`](https://github.com/issues?q=is%3Aopen+label%3Aarea%2Fblog+repo%3Akubernetes%2Fwebsite) +- GitHub Teams: [@kubernetes/kubernetes-blog](https://github.com/orgs/kubernetes/teams/kubernetes-blog), [@kubernetes/kubernetes-blog-maintainers](https://github.com/orgs/kubernetes/teams/kubernetes-blog-maintainers) ## Submit a Post @@ -42,25 +42,25 @@ To submit a blog post, you can either submit it using the [Kubernetes blog submi Requested Content (with examples): -* New Kubernetes capabilities -* Kubernetes projects updates -* Updates from Special Interest Groups -* Tutorials and walkthroughs -* Thought leadership around Kubernetes -* Kubernetes Partner OSS integration -* **Original content only** +- New Kubernetes capabilities +- Kubernetes projects updates +- Updates from Special Interest Groups +- Tutorials and walkthroughs +- Thought leadership around Kubernetes +- Kubernetes Partner OSS integration +- **Original content only** Unsuitable Content: -* Vendor product pitches -* Partner updates without an integration and customer story -* Syndicated posts (language translations ok) +- Vendor product pitches +- Partner updates without an integration and customer story +- Syndicated posts (language translations ok) ## Review Process -Once a blog post is submitted either via the form or a PR, it will be routed to the editorial team for review either via email for Google Docs or auto-assigning for a PR. +Once a blog post is submitted either via the form or a PR, it will be routed to the editorial team for review either via email for Google Docs or auto-assigning for a PR. -Each blog post requires a LGTM from one copy editor, technical editor*, and blog community manager. Once the necessary LGTMs are in place, an Editorial Lead will schedule and approve the blog post. +Each blog post requires a LGTM from one copy editor, technical editor\*, and blog community manager. Once the necessary LGTMs are in place, an Editorial Lead will schedule and approve the blog post. _If a blog post does not contain any technical content (for example, [How You Can Help Localize Kubernetes Docs](https://kubernetes.io/blog/2019/04/26/how-you-can-help-localize-kubernetes-docs/)), the technical review can be omitted._ @@ -82,15 +82,15 @@ We typically do not make edits to blog posts more than 1 years old. Each Editorial Team role is responsible for staffing their respective role, with this order of fall-through in mind: -* training and selecting a successor from the current pool of role shadows -* training and selecting a successor from non-Editorial Team members -* staffing the role themselves +- training and selecting a successor from the current pool of role shadows +- training and selecting a successor from non-Editorial Team members +- staffing the role themselves Ultimately, if none of these can be satisfied, responsibility falls to the Editorial Team Lead and SIG-Docs to staff the roles. ### Shadows -We are always open to adding new shadows to the editorial team roles. If you are interested in shadowing one of the roles on the team, please fill out [this application](TBD). We review applications on a rolling basis. +We are always open to adding new shadows to the editorial team roles. If you are interested in shadowing one of the roles on the team, please fill out [this application](The application form is now live for anyone interested in joining the blog editorial team: https://docs.google.com/forms/d/e/1FAIpQLScg9fHsyW-LlsBF8rc9J0sR8u3O3g17lwFUKIE-qrjL6Z-AyA/viewform?usp=sf_link). We review applications on a rolling basis. ### Removing a Team Member diff --git a/sig-docs/survey/2019SIGDocsSurveyRaw.ods b/sig-docs/survey/2019SIGDocsSurveyRaw.ods Binary files differnew file mode 100644 index 00000000..1449dad8 --- /dev/null +++ b/sig-docs/survey/2019SIGDocsSurveyRaw.ods diff --git a/sig-docs/survey/2019SIGDocsSurveyResultsCharts.pdf b/sig-docs/survey/2019SIGDocsSurveyResultsCharts.pdf Binary files differnew file mode 100644 index 00000000..05dd01c4 --- /dev/null +++ b/sig-docs/survey/2019SIGDocsSurveyResultsCharts.pdf diff --git a/sig-docs/survey/2019SeptSurvey.md b/sig-docs/survey/2019SeptSurvey.md new file mode 100644 index 00000000..6ba371f5 --- /dev/null +++ b/sig-docs/survey/2019SeptSurvey.md @@ -0,0 +1,140 @@ +| Data | Info | +| --- | --- | +Title | Kubernetes SIG Docs Survey 2019 +Authors | @aimeeu, @zacharysarah, @sftim with input from additional SIG Docs members (see [SIG-Docs: Documentation User Survey 2019](https://github.com/kubernetes/website/issues/15828)) +Tool Used | SurveyMonkey; @aimeeu worked with the CNCF to create the survey and obtain exported results +Start | 4 September 2019 +End | 7 September 2019 +Langauage | English +Data Processing | This survey did not ask for personal identifiers. Respondent's IP addresses have been removed from results. +Files | Presentation (2019SIGDocsSurveyResultsCharts.pdf) and raw results (2019SIGDocsSurveyRaw.ods) + + +### Questions + +1. What is your level of experience using Kubernetes? + - Beginner + - Experienced + - Expert +2. How do you use Kubernetes? + - Developer + - Administrator + - Developer and Administrator + - Other (please specify) +3. How do you usually access the Kubernetes documentation site most often? + - Phone + - Tablet + - Desktop +4. How long have you been using the Kubernetes documentation? + - Less than 6 months + - 6-12 months + - More than 12 months +5. In which languages do you read the Kubernetes documentation? + - German (de) + - English (en) + - Spanish (es) + - French (fr) + - Japanese (ja) + - Korean (ko) + - Portuguese (pt) + - Chinese (zh) +6. Is the Kubernetes documentation the first place you look for information about Kubernetes? + - Yes + - No +7. How easy is it to find content using the site’s navigation (top and left)? + - Not at all easy + - Slightly easy + - Moderately easy + - Very easy + - Extremely easy +8. How often do you use the search functionality to find content? + - Never + - Rarely + - Occasionally + - Every visit + - Several times per visit +9. Why do you access the Kubernetes documentation? Check all that apply. + - Installation for learning + - Installation for production + - Architecture + - Concepts + - Terminology (glossary) + - API reference + - kubectl CLI reference + - Tasks (administering a cluster, configuring pods, securing Kubernetes, upgrading, etc) + - Troubleshooting guidance + - Tutorials +10. How often do you find what you are looking for? + - Never + - Rarely + - Occasionally + - Most visits + - Every visit +11. Concepts: How satisfied are you with the level of detail in the Concepts section? + - Not at all satisfied + - Slightly satisfied + - Moderately satisfied + - Very satisfied + - Extremely satisfied +12. Concepts: How often do you find outdated content in the Concepts section? + - Never + - Rarely + - Occasionally + - Every visit + - Several times per visit +13. Concepts: How can we improve the Concepts section? Please select all that apply. + - More diagrams + - More example code + - More detailed content + - Other (please specify) +14. Tasks: How satisfied are you with the level of detail in the Tasks section? + - Not at all satisfied + - Slightly satisfied + - Moderately satisfied + - Very satisfied + - Extremely satisfied +15. Tasks: How often do you find outdated content in the Tasks section? + - Never + - Rarely + - Occasionally + - Every visit + - Several times per visit +16. Tasks: How can we improve the Tasks section? Please select all that apply. + - More diagrams + - More example code + - More detailed content + - Other (please specify) +17. Reference: How satisfied are you with the level of detail in the Reference section? + - Not at all satisfied + - Slightly satisfied + - Moderately satisfied + - Very satisfied + - Extremely satisfied +18. Reference: How often do you find outdated content in the Reference section? + - Never + - Rarely + - Occasionally + - Every visit + - Several times per visit +19. Reference: How can we improve the Reference section? Please select all that apply. + - More example code + - More detailed content + - Other (please specify) +20. Tutorials: How satisfied are you with the level of detail in the Tutorials section? + - Not at all satisfied + - Slightly satisfied + - Moderately satisfied + - Very satisfied + - Extremely satisfied +21. Tutorials: How often do you find outdated content in the Tutorials section? Please select all that apply. + - Never + - Rarely + - Occasionally + - Every visit + - Several times per visit +22. Tutorials: How can we improve the Tutorials section? Please select all that apply. + - Advanced tutorials (security, networking, configuration, troubleshooting, etc) + - Developer-oriented content + - The availability of interactive tutorials needs to be fixed + - Other (please specify) +23. How can we improve the Kubernetes documentation? |