mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-06 04:21:09 +00:00
docs: adds gsod 2024 folder and proposal page (#1499)
* docs: adds gsod 2024 folder and proposal page, as well as gsod discussion issue template * docs: updates gsod issue template with proper syntax for assignee * docs: ran prettier, updated some future tense, and removed broken link from gsod proposal to fix broken tests * docs: updates gmt utc time in gsod proposal * docs: updates typos and time zone statement in gsod proposal page
This commit is contained in:
23
.github/ISSUE_TEMPLATE/gsod-project-ideas.md
vendored
Normal file
23
.github/ISSUE_TEMPLATE/gsod-project-ideas.md
vendored
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
name: GSOD project ideas
|
||||||
|
about: Discuss or contribute to GSOD project ideas
|
||||||
|
title: 'GSOD project ideas'
|
||||||
|
labels: 'gsod'
|
||||||
|
assignees: '@HCloward'
|
||||||
|
---
|
||||||
|
|
||||||
|
**Which project would you like to contribute to or discuss?**
|
||||||
|
|
||||||
|
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||||
|
|
||||||
|
**Describe the changes or enhancements you would add**
|
||||||
|
|
||||||
|
<!-- A clear and concise description of what you want to happen. -->
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
|
||||||
|
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
|
||||||
|
<!-- Add any other context or screenshots about the feature request here. -->
|
||||||
151
docs/gsod/2024/proposal.md
Normal file
151
docs/gsod/2024/proposal.md
Normal file
@@ -0,0 +1,151 @@
|
|||||||
|
---
|
||||||
|
seo:
|
||||||
|
title: Redocly proposal - Google Season of Docs 2024
|
||||||
|
slug: /gsod-2024-proposal
|
||||||
|
theme:
|
||||||
|
feedback:
|
||||||
|
hide: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Google Season of Docs 2024 - Redocly proposal
|
||||||
|
|
||||||
|
[Google Season of Docs](https://developers.google.com/season-of-docs) provides support for open-source projects to improve their documentation and gives professional technical writers an opportunity to gain experience in open source.
|
||||||
|
Together we raise awareness of open source, of docs, and of technical writing.
|
||||||
|
|
||||||
|
Redocly is applying to participate in Google Season of Docs 2024.
|
||||||
|
|
||||||
|
## About Redocly
|
||||||
|
|
||||||
|
[Redocly](https://redocly.com/) was founded in 2017 with the mission to get more consumers using APIs with less hands-on support.
|
||||||
|
We were born out of [Redoc](https://redocly.com/docs/redoc/), the popular open-source OpenAPI documentation software project used by thousands of companies worldwide.
|
||||||
|
We make API design and documentation software with the goal to accelerate API ubiquity.
|
||||||
|
Our suite of products makes our customers’ APIs more accessible and loved by their end users and consumers.
|
||||||
|
|
||||||
|
## How to apply
|
||||||
|
|
||||||
|
We are glad you are interested in contributing to Redocly's open source project documentation.
|
||||||
|
Please send your [statement of interest](https://developers.google.com/season-of-docs/docs/tech-writer-statement) to [gsod@redocly.com](mailto:gsod@redocly.com) by April 26th.
|
||||||
|
|
||||||
|
Be sure to review the skills needed for each project and include references to your abilities in these areas in particular.
|
||||||
|
|
||||||
|
You also need to be able to meet remotely within the US East Coast and EU time zones.
|
||||||
|
|
||||||
|
## Volunteers/mentors
|
||||||
|
|
||||||
|
Heather Cloward - [heather.cloward@redocly.com](mailto:heather.cloward@redocly.com)
|
||||||
|
|
||||||
|
Lorna Jane Mitchell - [lorna.mitchell@redocly.com](mailto:lorna.mitchell@redocly.com)
|
||||||
|
|
||||||
|
## Project ideas
|
||||||
|
|
||||||
|
Our open-source tools allow developer teams to create clean, accessible documentation to complement their APIs.
|
||||||
|
By making sure that the project documentation is complete, accurate, and up-to-date, community contributors can add immense value to our open-source projects.
|
||||||
|
|
||||||
|
The following are the open source projects we would like some help with:
|
||||||
|
|
||||||
|
- [Redocly CLI](https://github.com/Redocly/redocly-cli): Redocly CLI is an open source command-line tool for working with OpenAPI descriptions, developer portals, and other API lifecycle operations including API linting, enhancement, and bundling.
|
||||||
|
- [OpenAPI starter](https://github.com/Redocly/openapi-starter): OpenAPI starter is a template repository that you can use to start your own OpenAPI project.
|
||||||
|
|
||||||
|
To contribute to or discuss the project ideas, create a GSOD project ideas issue on the [redocly-cli repo](https://github.com/Redocly/redocly-cli/tree/main) in GitHub.
|
||||||
|
|
||||||
|
### Redocly CLI guides
|
||||||
|
|
||||||
|
We would like to enhance the [guide section](https://redocly.com/docs/cli/guides/) of the [Redocly CLI documentation](https://redocly.com/docs/cli/) by having a technical writer complete the following tasks:
|
||||||
|
|
||||||
|
- Read and attempt to complete the steps in each guide.
|
||||||
|
- Edit guides for accuracy and usability.
|
||||||
|
- Add depth and examples where needed.
|
||||||
|
- Devise an information architecture to organize the guides in the sidenav and landing page.
|
||||||
|
|
||||||
|
#### Skills needed
|
||||||
|
|
||||||
|
The following skills are needed:
|
||||||
|
|
||||||
|
- Full Professional Proficiency in US English.
|
||||||
|
- Docs-as-code experience and skills.
|
||||||
|
- Strong understanding of OpenAPI.
|
||||||
|
- Comfortable working in the command-line.
|
||||||
|
- Familiarity with Markdown for documentation formatting.
|
||||||
|
|
||||||
|
### OpenAPI starter examples
|
||||||
|
|
||||||
|
We would like to enhance the OpenAPI starter project by having a technical writer complete the following tasks:
|
||||||
|
|
||||||
|
- Add more examples for complex use cases and scenarios.
|
||||||
|
- Add clear explanations for when and why you would use each option.
|
||||||
|
- Review and edit the README files with further explanations and examples where needed.
|
||||||
|
- Review and update the [How to use openapi-starter guide](https://redocly.com/docs/cli/openapi-starter/).
|
||||||
|
|
||||||
|
#### Skills needed
|
||||||
|
|
||||||
|
The following skills are needed:
|
||||||
|
|
||||||
|
- Full Professional Proficiency in US English.
|
||||||
|
- Docs-as-code experience and skills.
|
||||||
|
- Strong understanding of OpenAPI.
|
||||||
|
- Comfortable working in the command-line.
|
||||||
|
- Familiarity with Markdown for documentation formatting.
|
||||||
|
|
||||||
|
## Success metrics
|
||||||
|
|
||||||
|
The following are the success metrics for our projects:
|
||||||
|
|
||||||
|
- Increase in page views after updates.
|
||||||
|
- Increase in positive reviews using our feedback mechanism.
|
||||||
|
- Reduction in negative reviews using our feedback mechanism.
|
||||||
|
|
||||||
|
## Timeline
|
||||||
|
|
||||||
|
{% table %}
|
||||||
|
|
||||||
|
- Time frame
|
||||||
|
- Expected activities
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- April 10 - 28
|
||||||
|
- Review technical writer statements of interest
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- May 1 - 10
|
||||||
|
- Hire technical writers
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- May 20 - November 20
|
||||||
|
- Documentation work is completed
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- November 23 - December 10
|
||||||
|
- Final project evaluation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- December 13
|
||||||
|
- Google posts program results
|
||||||
|
{% /table %}
|
||||||
|
|
||||||
|
## Budget
|
||||||
|
|
||||||
|
{% table %}
|
||||||
|
|
||||||
|
- Budget item
|
||||||
|
- Total amount
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- Technical writer stipend
|
||||||
|
- $5,000
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- Technical writer stipend
|
||||||
|
- $5,000
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
- **Budget Total**
|
||||||
|
- **$10,000**
|
||||||
|
{% /table %}
|
||||||
Reference in New Issue
Block a user