Skip to content

Commit

Permalink
Technical Docs Work group block and guide (#3791)
Browse files Browse the repository at this point in the history
Signed-off-by: Orlin Vasilev <ovasilev@vmware.com>
  • Loading branch information
OrlinVasilev authored Jun 11, 2021
1 parent caedf10 commit 05d6ee3
Show file tree
Hide file tree
Showing 3 changed files with 92 additions and 0 deletions.
42 changes: 42 additions & 0 deletions site/content/posts/2021-06-10-docs-wg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Join the Contour Tech Docs Working Group
excerpt: Announcing Contour Technical Documentation Working Group
author_name: Contour Team
author_avatar: /img/contributors/orlin-vasilev.jpg
categories: [kubernetes]
tags: ['Contour Team', 'Abigail McCarthy', 'Docs' ,'Docs-WG', 'Jonas Rosland', 'Orlin Vasilev']
date: 2021-06-10
slug: docs-wg
---

The Contour team is excited to announce we are launching a technical documentation working group. This group will focus on improving the Contour website, documentation, and processes around content creation.

# Because documentation makes a difference

In 2017, GitHub conducted the [Open Source Survey](https://opensourcesurvey.org/2017/), which sampled 5,500 respondents. One of the key takeaways was that “documentation is highly valued, but often overlooked.” The survey found that outdated or confusing documentation was a major problem, affecting 93% of respondents. Yet 60% of contributors rarely or never contribute to documentation. We want this working group to be an opportunity to give back to the community by helping to improve the docs.

# The purpose and scope of the Working Group

The purpose of the Working Group is to build up a self-sustaining community around documentation for Contour. We have an initial need to rework the existing documentation based on the recommendations outlined in the [CNCF Tech Docs Review](https://github.com/cncf/techdocs/blob/main/assessments/0001-contour.md), and a continuous need for documentation being added/edited/removed for releases going forward.
This group is open to contributors of all levels, the only requirement is being interested in helping with docs!

# How to participate
Join us for our kickoff meeting on June 17th at 1PM Eastern Standard/Daylight Time [Time zone converter](https://www.timeanddate.com/worldclock/usa/boston) as part of the Contour Office Hours. During the kickoff meeting, we’ll have an information session about this working group, covering the following topics

- Working Group participation
- The docs tool chain and how to set up your environment
- How to preview the documentation locally before submitting a pull request
- Anything else you’d like to know about helping with Contour documentation!

We’ll be continuing to hold Working Group meetings and information sessions during the regular Contour Office Hours time every 1st and 3rd Thursday at 1PM after the kickoff meeting.
Get the invite to the Contour Office Hours by joining the [Contour mailing list](https://lists.cncf.io/g/cncf-contour-users/).

You can find the [Contributing Guide here](/resources/contributing-docs).
# We look forward to seeing you!
Thank you for being willing to take time from your schedule to participate in the Contour Tech Docs Working Group. Your help will drive new user guides and better documentation for the project, enriching the community for everyone by teaching new and experienced contributors and users the fundamental concepts of Contour and how to use it.
We hope to see you soon!

# Authors
- Abigail McCarthy - @a-mccarthy
- Jonas Rosland - @jonasrosland
- Orlin Vasilev - @OrlinVasilev
50 changes: 50 additions & 0 deletions site/content/resources/contributing-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Contributing Technical Documentation
layout: page
---

# Contour Technical Documentation Contributing Guide

The purpose of the Working Group is to build up a self-sustaining community around documentation for Contour. We have an initial need to rework the existing documentation based on the recommendations outlined in the [CNCF Tech Docs Review](https://github.com/cncf/techdocs/blob/main/assessments/0001-contour.md), and a continuous need for documentation being added/edited/removed for releases going forward.
This group is open to contributors of all levels, the only requirement is being interested in helping with docs!

## Getting started with in the Working Group

Whenever you’re available to join, come say hi using either method:

- Join the [Contour Office Hours Zoom](https://zoom.us/j/96698475744?pwd=KzVUd3BZSWI2bWIxTmhjZ2d5QVcxUT09) every 1st and 3rd Thursday at 1-2pm ET / 10am-11pm PT and introduce yourself
- On the [Kubernetes Slack workspace](https://slack.k8s.io/), join the [#contour](https://kubernetes.slack.com/messages/contour) channel and introduce yourself

When you introduce yourself, let us know:

- Why you are interested in participating in the working group and what you hope to get out of your time contributing to the Contour docs
- Your prior experience level with our docs toolchain (Git and GitHub, Markdown, Hugo, HTML) and where you need some help
- Which operating system you’re using (for help with setting up your environment)

We can help you help find an open issue to work on or answer any questions you have about writing Contour docs. If you notice something about the docs you'd like to improve, please file an issue and bring it up with the working group. We'd love to hear your ideas.

### Set up your environment

Make sure you have the following installed:

- A GitHub login
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Hugo](https://gohugo.io/getting-started/installing)
- A good editor

Now you can start editing content:

1. Start by [forking](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) the [contour](https://github.com/projectcontour/contour) repo
1. Within the `contour/site` directory, you will find the entire [projectcontour.io](https://projectcontour.io) website
1. Within the `contour/site/content` directory you will find our docs, our resources, guides and so forth
1. The `docs` directory is divided into `main` which is the latest development docs, and `1.X.Z` where you will find the latest released versioned docs
1. For new content for future versions, it should be created in `main`
1. For edits to older versioned docs, first make the edits to that specific version (spelling errors, broken links etc) and then verify if those changes should also be incorporated in the `main` directory for the latest development docs

### Create a Pull Request with your changes

Please see the [CONTRIBUTING doc](https://github.com/projectcontour/contour/blob/main/CONTRIBUTING.md#contribution-workflow) in the section "Contribution workflow" for more detailed information on how to commit your changes and submit a pull request.

### What if you can’t finish your work?

When you join the working group and get assigned an issue, we'd ask that you try to open a pull requests with your fixes within a few days. If you are unable to finish your assigned issue, please submit a pull request with the content that you were able to create and update the Github issue with the latest information of your progress. This way your work goes to use, you get credit for your a contributions, and we can work with other team members to continue making progress on the issue :)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 05d6ee3

Please sign in to comment.