From 93fe1aeb1867c02a95c40a7b2a7246edd166c692 Mon Sep 17 00:00:00 2001 From: Justine Geffen Date: Tue, 20 Jul 2021 18:38:06 +0200 Subject: [PATCH] Create docathon page for docathon 2021 (#786) * Update and rename docathon-processes.md to docathons.md * Update SUMMARY.md * Update and rename docathons.md to docathon-2021.md * Update SUMMARY.md * Update docathon-2021.md * Update docathon-2021.md * Create docathon-processes.md * Update SUMMARY.md * Create community-documentation-process.md * Update operations/research-and-development/product/technical-writing/community-documentation-process.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/community-documentation-process.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/community-documentation-process.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/community-documentation-process.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-processes.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-processes.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-processes.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-2021.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-2021.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-2021.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-2021.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update operations/research-and-development/product/technical-writing/docathon-2021.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update docathon-processes.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> --- SUMMARY.md | 2 ++ .../community-documentation-process.md | 15 ++++++++++++ .../technical-writing/docathon-2021.md | 24 +++++++++++++++++++ .../technical-writing/docathon-processes.md | 23 ++++++++++++++++-- 4 files changed, 62 insertions(+), 2 deletions(-) create mode 100644 operations/research-and-development/product/technical-writing/community-documentation-process.md create mode 100644 operations/research-and-development/product/technical-writing/docathon-2021.md diff --git a/SUMMARY.md b/SUMMARY.md index dadf46a1b..408ab798f 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -80,6 +80,8 @@ * [Product Management Areas of Ownership](operations/research-and-development/product/product-ownership-areas.md) * [Product Manager Onboarding](operations/research-and-development/product/pm-onboarding.md) * [Technical Writing Team Handbook](operations/research-and-development/product/product-technical-writing-team-handbook.md) + * [Docathon 2021](operations/research-and-development/product/technical-writing/docathon-2021.md) + * [Getting Started with Contributing](operations/research-and-development/product/technical-writing/docathon-processes.md) * [Analytics](operations/research-and-development/product/analytics/README.md) * [Looker](operations/research-and-development/product/analytics/looker/README.md) * [Dashboards](operations/research-and-development/product/analytics/looker/dashboards.md) diff --git a/operations/research-and-development/product/technical-writing/community-documentation-process.md b/operations/research-and-development/product/technical-writing/community-documentation-process.md new file mode 100644 index 000000000..5ae66a58e --- /dev/null +++ b/operations/research-and-development/product/technical-writing/community-documentation-process.md @@ -0,0 +1,15 @@ +# Community Documentation + +In the past, community-managed documentation lived in the product documentation. This created some confusion because, although the content was in our product documentation, it wasn't written and tested by Mattermost and thus not officially supported. + +Additionally, having the content hosted on a static site didn't lend itself to engagement and interaction. + +Going forward, our existing community-written documentation will be available on the [Mattermost Forum](https://forum.mattermost.org/) within a dedicated forum category called **Unofficial Product Documentation**. + +## Process for new community-written content + +If you've written, or want to write, new content for Mattermost, please add it as a new thread in the [Unofficial Product Documentation](https://forum.mattermost.org/c/docs/37) category. + +Once submitted, you'll receive notifications about any activity on your post. + +We encourage interaction, especially as well-tested community documentation often ends up being added to our product documentation. diff --git a/operations/research-and-development/product/technical-writing/docathon-2021.md b/operations/research-and-development/product/technical-writing/docathon-2021.md new file mode 100644 index 000000000..f721322a8 --- /dev/null +++ b/operations/research-and-development/product/technical-writing/docathon-2021.md @@ -0,0 +1,24 @@ +# Documentation Hackathon 2021 + +The first Mattermost Docathon is being held from July 26th to August 6th 2021. Take a look at our [blog post](https://mattermost.com/blog/docathon-2021/) if you haven't already. + +## What is a Docathon? + +A docathon is a hackathon for product documentation. + +## Why a Docathon? + +Documentation isn't written in a vacuum, and it's important to see the customer’s documentation journey through the eyes of our Mattermost community. The best way to do that is to get our community involved! Documentation is also a great way to get started on your open source contribution journey as it's usually how you get to know the product. + +## Who can participate? + +The Docathon is designed to provide opportunities for all contributors to get involved, whether new to open source or seasoned contributors. Help us solve technical tooling challenges. Write mobile steps for Mattermost messaging tasks. Correct inaccuracies and inconsistencies. Add or update screenshots, labeled images, animated GIFs, and videos. How do you want to improve the Mattermost product documentation? + +## Can Mattermost staff help? + +Absolutely! Here are some ways you can get involved: + +* **Help us merge PR submissions:** This includes helping us go through the PRs with the **Docathon 2021** label, making sure PRs follow our style guide, and fixing any grammatical issues. This isn't an extremely rigorous process - we just want to make sure anything merged follows some standardization. +* **Help review technical content for accuracy:** Actively monitor the [~Docathon 2021](https://community-daily.mattermost.com/core/channels/docathon2021) channel, respond to questions, and engage community members who post with questions or concerns. You can also help by being open to contributors messaging you directly if they have questions and prefer not to ask in the public channel, and relay any feedback back to the Technical Writing team. +* **Help us with Linked In recommendations or endorsements for top contributors:** This is particularly welcome in cases where, during PR reviews, you encounter Docathon contributors you want to network with and whose professional career you want to support. +* **Contribute your own content or ideas for either Mattermost product documentation, or the Docathon event itself!** diff --git a/operations/research-and-development/product/technical-writing/docathon-processes.md b/operations/research-and-development/product/technical-writing/docathon-processes.md index d28ba2430..bdbbeafa3 100644 --- a/operations/research-and-development/product/technical-writing/docathon-processes.md +++ b/operations/research-and-development/product/technical-writing/docathon-processes.md @@ -1,3 +1,22 @@ -# Documentation Hackathon 2021 +# Docathon 2021: Getting Started -**WIP** +We're super-excited to work with you! There are a few things you should know before you get started. + +## Where to find things + +The Docathon covers two areas: + +* Product documentation: This lives in the [docs repo](https://github.com/mattermost/docs). +* Developer documentation: This lives in the [developer documentation repo](https://github.com/mattermost/mattermost-developer-documentation). + +## Submissions + +You can submit contributions in one or more of the following ways: + +* Open a PR directly from a doc page using the GitHub **Edit** option in the top-right corner of the page. +* Visit the docs repo, find the page you want to edit, and open a PR that way. +* Create new content! You may not be able to create a branch for your new content, but feel free to create a Google doc and share it with us. We'll work with you on finding the perfect place for it. + +## Reviews and editing + +We don't expect perfection, so please don't spend a lot of time trying to follow the style guide rigorously. That's our job! Bear in mind that we may edit your PR directly for stylistic changes. The only reason we do this is because it's quicker - if you have any questions about changes we've made, we'll be more than happy to go through them with you!