-
Notifications
You must be signed in to change notification settings - Fork 828
Kubeflow Doc Fixit at Write the Docs AU 2019
Are you coming to the Write the Docs Australia 2019 conference on 14-15 November in Sydney? You're invited to join us in a two-hour doc fixit on Thursday afternoon, as part of the conference.
Become a contributor to an open source project, learn a bit about how open source works, and help improve the experience of Kubeflow users. All in just two hours!
During the fixit, you'll add a touch of tech writer shine to the Kubeflow docs. Docs are a super important part of the user experience of any product. Typos and grammatical inconsistencies can spoil that UX. Yet typos and odd syntax creep into any doc set easily. You can help us set things right.
The doc fixit hosts are:
- Sarah Maddox (Kubeflow tech writer at Google)
- Alec Glassford (Tech writer at Google)
- Riona MacNamara (Tech writer manager at Google)
Here's how the fixit works:
- We have a spreadsheet with a list of doc bugs that need fixing. The bugs are the type of problem that you can fix without knowing the software that the docs cover: typos, consistency in page structure, capitalization, and so on.
- Doc fixit participants choose the bugs that they want to fix.
- The fixit assistants help the participants create GitHub IDs where necessary.
- Each participant creates an issue in the GitHub issue tracker, describing the bug they're about to fix.
- The participant then updates the relevant doc on GitHub and sends a pull request (PR) for review.
- The fixit assistants help people sign the contributor licence agreement if necessary. (A bot will prompt them to do this when they send their first PR.)
- The fixit assistants review the PRs and approve each PR when it's ready.
- The continuous merge/publish tools on the GitHub project merge the PR and publish the update in the docs.
- The participant sees their update appear in the docs!
Here's how you can prepare for the Kubeflow doc fixit:
- Bring a laptop with WiFi capabilities.
- If you don't already have a GitHub account, sign up for one. If you have time to do this before the start of the sprint, that's great. If not, you can do it during the sprint.
- Sign the Google Contributor License Agreement (CLA). If you have time to do this before the start of the sprint, that's great. If not, you can do it during the sprint.
- It's not mandatory to do any prework, but it will help if you know some Markdown.
- Details of the Kubeflow doc fixit on the Write the Docs AU site.
- The Kubeflow documentation site.
- The Kubeflow docs source on GitHub.