community/sig-docs/meeting-notes-archive/2016_Weekly_Meeting_Minutes.md

13 KiB
Raw Blame History

12/13/2016

  • 1.5 is out the door. Wooo.
    • New site org in 1.5
    • Added to tasks, tutorials, and concepts
    • Statefulset docs fell under concepts, tutorials, and tasks.
    • We want to do this the same way going forward.
  • Template issues :(
    • Github issues with templates :(
    • They update, we break. Markdown processor breaks the site.
      • First update broke the site chrome.
      • Current change breaks how we automate page titling.
    • AI:
      • Explore Moving to using netlify to stage the site? (Jessfraz, Ddonnelly)
      • Fix Page title needs to be fixed.
      • Explore fixing templating in github pages.
      • Propose hiring a web-dev for the team.
  • TOCs
    • Some pages that have TOCs in flux (tools page, for example)
    • Should figure out a standard for organizing these pages.
      • Concepts (Ddonnelly)
      • Tasks, Tutorials (Stevepe)
  • Issues Triaging, Templates, Standards
  • 1.5 RefDocs Update
  • Versioning
    • Some thoughts:
      • Maintain a release branch for each release
      • Stage using netlify
      • Clarify the level of support for release branches
      • Only 1.5 going forward
  • Deprecation notices
    • Going to land on the site. Devin will decide.

11/28/2016

  • Meeting using Zoom
  • 1.5 Launches (Ihor, Jared)
  • License Updates (Jared)
  • Style Guides (Steve)
    • PRs checked in
    • Old Templates deleted. Long live the new templates.
    • In progress: Remove some content from README and editdocs, and blend it into the new contribution pages.
  • Issues Triaging (Abby)
    • PR coming soon
    • 1/10 triage day!
    • Kubernetes swag will be given
  • Quickstart Discussion: Bill Prin
    • Move getting started and creating a cluster content to “tasks”
    • Revamp content, remove GKE “Hello Node”
    • Jeff and Bill will come up with a more in depth proposal for next week.
  • API Reference docs (Phillip)

11/15/2016

Agenda:

10/25/2016

Agenda

10/11/2016

No meeting due to technical issues.

9/27/2016

Announcements

Agenda

Kudos

  • Phillip Wittrock
  • Devin Donnelly

9/20/2016

Agenda

  • 1.4 Delayed until next week (1.4 Spreadsheet)
  • Doc Templates
    • Any more feedback?
    • Still adding canonical examples
    • Outstanding questions for those TBD by jeffmendoza
  • Bootcamp integrated into master (pending PR)
    • Not using the templates
    • Keeping the existing CSS
  • Issue Template update?
    • PR filed
      • CLA isnt approved. Weird.
      • Is your github account under your companys email?
    • Next Steps:
      • Submit PR
      • AI: Develop proposal for handling backlog of issues (Abby)
      • Run it by Frank for review
  • Dead link report:
    • AI: Regenerate the report, mark what will fixed in the upcoming release (1.4), focus on fixing manually generated content

Updates:

  • New “edit docs” button at the bottom of the page
  • Fix in for generating API and Kubectl docs (no more broken links! Wont get in until 1.4).
  • Kudos to Abby for creating the PR for issue templates

9/13/2016

Agenda

  • Update on Netlify! (Devin)
  • Dan Paik - new PM on Gcloud/K8s - will be working on cluster deployments, GKE UI, and PetSet deployments

Updates:

  • “I wish” is gone. “File an issue” instead. (thanks Jeff!)
    • Still need guidelines to close issues :)
  • Status of issue templates and guidelines? (Abby?)
    • Took a stab at making an issue template (in Google Doc)
    • Feedback:
      • Keep existing title with URL
      • Specify feature vs. bug (new doc vs. doc update)
    • File a PR :)
  • 1.4 Process
  • Templates (Steve)
      • Netlify
  • SEO Issues with K8s

August 30, 2016

Agenda:

  • Customer Feedback:
    • “I wish”
      • Make an issue / Make an edit
      • Remove the functionality, replace with make an issue/made edits
      • AI: Jeff Mendoza
    • Star ratings vs. Thumbs Up
  • Issues :(
    • 300 issues
    • Write up a md file for issue guidelines?
    • Issue templates?
      • AI: Abby:
        • Issue guidelines
        • Issue template
    • Close issues that dont conform
  • Steve chat through new templates.
  • 1.4 Features and Publishing
    • Alpha: 14 Open Issues
    • Beta: 8 Open Issues
    • Stable: 5 Open Issues
    • Publishing process?
      • Current release branch
      • Under development release
      • Make a rule that any change in the current version has to be made in the “under development” version.

August 23, 2016

Agenda

August 16, 2016

Kickoff Meeting!

Agenda

  • Introductions - New Members
    • Jared (TW, Manager), Phillip (SWE, UX), Devin (TW), Steve (TW), Josh (SWE), Dan Romlein (UX, Apprenda), Abby (TW, Apprenda), Sarah Novotny (Community), Janet (SWE, UX), Frank, Morgan (TW, IBM)
  • Current state of the docs (Jared)
    • John Mulhausen has left the group
    • Devin and Steve are joining full time from Google
    • We want to make things easier for users navigating the site, and contributors contributing to the site.
  • Doc goals and doc plans (Devin)
    • Building on Johns work, building new processes.
    • Some findability and readability improvements in the short term.
    • Significant problems with findability.
      • Title != URL != Place in table of contents.
    • Good content with some better organization
      • For example:
        • Glossary is a collection of “conceptual articles”. Should better explain the “kubernetes model”
        • Also, a good place for new diagrams.
    • Better guidance on audience. Explicitly state who our audience is:
      • App Builders - Just running an application on top of K8s. Probably dont want/need to know too much about whats “under the hood”
      • Container Maintainers/Builders - Want to know the deeper aspects of K8s.
    • Build out the contributor
      • Style Guide (titling docs, content fit into categories, tone and term usage to unify content and fix SEO)
      • Templates - Build out
      • Contribution process
    • Questions:
      • Third party docs? How do we build and maintain them?
        • Proposal - that content should not live inside the core repo, since we cant maintain it well.
        • No objections to this proposal so far.... Need to have a way to separate this process out and find new homes for it.
        • Need an owner for this process.

Additional Agenda Items?

  • New contributor onboarding process (Phillip)
    • Style guide (Josh)
    • Initial tasks for new contributors
    • Repo Issues list
      • Github Issues that writers take on?
    • Getting help
      • Slack Channel (#sig-docs) for folks who need help or guidance.
      • Feel free to ping
      • To login to Zoom: Phillip directly.
  • Diagrams - How should we create these? (Phillip)

Issues, suggestions, concerns, kudos?

  • Kudos: Thanks to Phillip Wittrock and Kelsey Hightower for closing out our list of outstanding docs PRs