Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setting up GSoD 2023 #840

Merged
merged 3 commits into from
Feb 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ labels:
color: f4af97
- name: summer of code
color: 00ffff
- name: season of docs
color: 00ff80
- name: spring
color: 1ED626
- name: "Term 1: March-May"
Expand Down
104 changes: 17 additions & 87 deletions seasonofdocs/README.md
Original file line number Diff line number Diff line change
@@ -1,98 +1,28 @@
---
maintainers:
- caniszczyk
- idvoretskyi
- zacharysarah
- celestehorgan
---

# Google Season of Docs 2021

Google [Season of Docs](https://developers.google.com/season-of-docs) (GSoD) gives technical writers an opportunity to work with open source projects.

The CNCF is applying to participate in GSoD 2021!

## 2021 Timeline

Google Season of Docs 2021 makes numerous change to the program from previous years:

1. GSoD 2021 permits only one project proposal per organization.

This marks a significant change from the multiple proposals allowed in previous years.

1. GSoD 2021 starts earlier and runs longer! Projects begin in April/May and run until November.

1. Project proposals include a new requirement for budgeting.

For more information, see the [proposal template](https://developers.google.com/season-of-docs/docs/org-proposal-template).

### What's happening right now?

Date | Activity
---|---
March 26, 2021 | The CNCF has submitted a [project proposal](#project-proposal) for consideration.
# Season of Docs

All steps are based on the [GSoD 2021 timeline](https://developers.google.com/season-of-docs/docs/timeline).
Google [Season of Docs](https://developers.google.com/season-of-docs) gives technical writers an opportunity to work with open source projects.

## Project Proposal
The CNCF is applying to participate in the Season of Docs as an org in 2023. We'll announce more details pending our acceptance into the program.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nate-double-u Hi Nate, when will GSoD 2023 be opened for CNCF maintainers to submit the project proposals?

Copy link
Member Author

@nate-double-u nate-double-u Feb 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I was unclear, you can submit proposals now. Here's the announcement: #843


Reorganize Contour’s documentation
[GSoD Timeline](https://developers.google.com/season-of-docs/docs/timeline)

### What's the problem?
### Program Cycles and Archive data

The information architecture for [Contour](https://projectcontour.io) needs help:
| Year | Term | Status | Announcement | Details |
|------|------|----------|--------------|----------------------|
| 2023 | Q2 | Planning | TBD | |

- Headings focus on functionality rather than user tasks
- There’s an abundance of familiar terms overloaded with new definitions
- Information is organized haphazardly and inconsistently
- The new user experience is confusing, with artificially high barriers to entry
## 2023 project proposals

Help Project Contour reorganize its documentation around a user's task flow and improve documentation navigability.
CNCF project maintainers interested in mentoring a technical writer have until **March 14th, 2023** to submit a [documentation proposal](https://developers.google.com/season-of-docs/docs/org-proposal-template) for your CNCF project.

### How would we measure success?
Well-scoped projects have:
- Clear scope: what will and won't a writer work on?
- Clear goals: when does the writer's work end?
- Clear metrics: how will you and the writer know you've succeeded?
- Clear budgeting: what are your project costs for a writer?

- Shorter onramp time for new users
- Increased support deflections by using docs
- Docs provide effective 1 to many support, measured in fewer requests for 1:1 support from project team
- Create a getting started guide for new Contour users
- Optimize content for actual developer and user workflows
- Provide consistent presentation: adhere to style guide, headings are consistent, and language is grammatically correct
Complete your proposal by **March 14th, 2021.** Due to anticipated volume, projects submitted after March 14th may not be considered.

### What skills does a writer need?

Required:
- Familiarity with Git, Markdown and Hugo

Nice to have:
- Distributed systems experience: networking, containers, Kubernetes and Envoy in particular

### Volunteers

- @celestehorgan – Lead for technical writing mentorship; approver for work
- @jonasrosland – Main point of contact for Contour and approver for work
- @stevesloka, @krisss, @youngnick – Technical experts and PR approvers

### Budget

Total budget: $15,000 USD

Writer: $14,350
Volunteers: 4 @ $100
Stickers: $100
T-shirts: $150

### Contact info

**Before applying**, please note:

- Email is the only acceptable channel for contact about GSoD.
- Do not contact admins about GSoD via chat apps or in any other channel.
- The program page for [Google Season of Docs](https://developers.google.com/season-of-docs/docs) is the best source of information for questions about the program, including [relevant dates](https://developers.google.com/season-of-docs/docs/timeline).

To apply, send an email to [[email protected]](mailto:[email protected]). Include links to examples of your technical writing portfolio and résumé/CV.

## Previous years
---

| Year | Term | Status | Announcement | Details |
|------|------|----------|------------------------|----------------------|
| 2020 | Q2 | Accepted | http://goo.gle/2WOt8xs | [Q2'2020](previous-years/2020/README.md) |
98 changes: 98 additions & 0 deletions seasonofdocs/previous-years/2021/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
maintainers:
- caniszczyk
- idvoretskyi
- zacharysarah
- celestehorgan
---

# Google Season of Docs 2021

Google [Season of Docs](https://developers.google.com/season-of-docs) (GSoD) gives technical writers an opportunity to work with open source projects.

The CNCF is applying to participate in GSoD 2021!

## 2021 Timeline

Google Season of Docs 2021 makes numerous change to the program from previous years:

1. GSoD 2021 permits only one project proposal per organization.

This marks a significant change from the multiple proposals allowed in previous years.

1. GSoD 2021 starts earlier and runs longer! Projects begin in April/May and run until November.

1. Project proposals include a new requirement for budgeting.

For more information, see the [proposal template](https://developers.google.com/season-of-docs/docs/org-proposal-template).

### What's happening right now?

Date | Activity
---|---
March 26, 2021 | The CNCF has submitted a [project proposal](#project-proposal) for consideration.

All steps are based on the [GSoD 2021 timeline](https://developers.google.com/season-of-docs/docs/timeline).

## Project Proposal

Reorganize Contour’s documentation

### What's the problem?

The information architecture for [Contour](https://projectcontour.io) needs help:

- Headings focus on functionality rather than user tasks
- There’s an abundance of familiar terms overloaded with new definitions
- Information is organized haphazardly and inconsistently
- The new user experience is confusing, with artificially high barriers to entry

Help Project Contour reorganize its documentation around a user's task flow and improve documentation navigability.

### How would we measure success?

- Shorter onramp time for new users
- Increased support deflections by using docs
- Docs provide effective 1 to many support, measured in fewer requests for 1:1 support from project team
- Create a getting started guide for new Contour users
- Optimize content for actual developer and user workflows
- Provide consistent presentation: adhere to style guide, headings are consistent, and language is grammatically correct

### What skills does a writer need?

Required:
- Familiarity with Git, Markdown and Hugo

Nice to have:
- Distributed systems experience: networking, containers, Kubernetes and Envoy in particular

### Volunteers

- @celestehorgan – Lead for technical writing mentorship; approver for work
- @jonasrosland – Main point of contact for Contour and approver for work
- @stevesloka, @krisss, @youngnick – Technical experts and PR approvers

### Budget

Total budget: $15,000 USD

Writer: $14,350
Volunteers: 4 @ $100
Stickers: $100
T-shirts: $150

### Contact info

**Before applying**, please note:

- Email is the only acceptable channel for contact about GSoD.
- Do not contact admins about GSoD via chat apps or in any other channel.
- The program page for [Google Season of Docs](https://developers.google.com/season-of-docs/docs) is the best source of information for questions about the program, including [relevant dates](https://developers.google.com/season-of-docs/docs/timeline).

To apply, send an email to [[email protected]](mailto:[email protected]). Include links to examples of your technical writing portfolio and résumé/CV.

## Previous years

| Year | Term | Status | Announcement | Details |
|------|------|----------|------------------------|----------------------|
| 2020 | Q2 | Accepted | http://goo.gle/2WOt8xs | [Q2'2020](previous-years/2020/README.md) |