Skip to content

Commit

Permalink
chore(docs): rename the Github learning team (#26673)
Browse files Browse the repository at this point in the history
* Rename the Github learning team

- Update team name in CODEOWNERS
- Update team name references in docs

[ch11559]

* Update team name within PR template [ch11559]

* Rename team in PR management

[ch11559]

* Remove deprecated doc project & website team

* Remove mention of Learning GitHub project

* Remove mention of Learning GitHub project

Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
  • Loading branch information
Janson Hartliep and Aisha Blake committed Sep 22, 2020
1 parent a344a12 commit 510370d
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -21,7 +21,7 @@
- Update any references, if relevant. This includes Guides and Gatsby Internals docs.
- If no docs exist:
- Create a stub for documentation including bullet points for how to use the feature, code snippets (including from happy path tests), etc.
- Tag @gatsbyjs/learning for review, pairing, polishing of the documentation
- Tag @gatsbyjs/documentation for review, pairing, polishing of the documentation
-->

## Related Issues
Expand Down
6 changes: 3 additions & 3 deletions CODEOWNERS
Validating CODEOWNERS rules …
Expand Up @@ -2,9 +2,9 @@
* @gatsbyjs/core

# All docs must be reviewed by the docs team.
/docs/ @gatsbyjs/learning
**/README.md @gatsbyjs/learning
dictionary.txt @gatsbyjs/learning
/docs/ @gatsbyjs/documentation
**/README.md @gatsbyjs/documentation
dictionary.txt @gatsbyjs/documentation

# Benchmarks
/benchmarks/ @duffn @pvdz @smthomas
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/docs-templates.md
Expand Up @@ -12,7 +12,7 @@ Here are some things to keep in mind when deciding where to contribute to Gatsby
- [Recipes](/contributing/how-to-write-a-recipe) add concise, discoverable, and easy-to-follow instructions for common Gatsby tasks. They are smaller units than tutorials.
- [Tutorials](/contributing/how-to-write-a-tutorial) should provide step-by-step guidance for Gatsby workflows, listing all pre-requisites and not assuming knowledge or skipping steps.

When writing (or reviewing) learning materials that show Gatsby users how to complete tasks, you are expected to **test out any code examples or steps to ensure they work**. This can also help with writing in your own words, rather than copying from other sources. If you have a demo project or code example that strengthens docs and you don't know where to put it, mention it to the Gatsby Learning team in a PR.
When writing (or reviewing) learning materials that show Gatsby users how to complete tasks, you are expected to **test out any code examples or steps to ensure they work**. This can also help with writing in your own words, rather than copying from other sources. If you have a demo project or code example that strengthens docs and you don't know where to put it, mention it to the Gatsby Documentation team in a PR.

## Why use templates?

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/docs-writing-process.md
Expand Up @@ -4,7 +4,7 @@ title: Docs Writing Process

When a new feature or integration is released that Gatsby developers can take advantage of, documentation should be added to improve the learning experience. Gatsby also needs docs for topic areas that exist in other technologies but are under-documented or under-tooled in the Gatsby ecosystem.

The knowledge of how to work with a technique, source plugin, or varied use case may be known internally to Gatsby team members, but it also may only exist on the web at large. This contributing doc is intended to provide a written process for producing docs without prior information, a critical function of the Gatsby Learning team and open source community.
The knowledge of how to work with a technique, source plugin, or varied use case may be known internally to Gatsby team members, but it also may only exist on the web at large. This contributing doc is intended to provide a written process for producing docs without prior information, a critical function of the Gatsby Documentation team and open source community.

## Identifying a topic

Expand Down
6 changes: 2 additions & 4 deletions docs/contributing/how-to-write-a-reference-guide.md
Expand Up @@ -57,8 +57,7 @@ Guide topics should be chosen based on these priorities:
1. [Stub articles](/contributing/stub-list/) (docs that already exist on the site but don't have content in them yet)
2. Articles with the [help wanted and type:documentation](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22type%3A+documentation%22) labels on GitHub
3. Articles related to improving [key learning workflows](https://github.com/gatsbyjs/gatsby/issues/13708)
4. Articles listed in the "Backlog" or "To prioritize" sections of the [Learning / Devrel Roadmap](https://github.com/gatsbyjs/gatsby/projects/10) on GitHub
5. Articles that you or other community members would like to see
4. Articles that you or other community members would like to see

### Length of a reference guide

Expand Down Expand Up @@ -143,8 +142,7 @@ Guide overview articles are essentially new parent categories that help organize
1. [Stub articles](/contributing/stub-list/) (docs that already exist on the site but don't have content in them yet)
2. Article sections with the [help wanted and type:documentation](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22type%3A+documentation%22) labels on GitHub
3. Article sections related to improving [key learning workflows](https://github.com/gatsbyjs/gatsby/issues/13708), like "e-commerce"
4. Article sections listed in the "Backlog" or "To prioritize" sections of the [Learning / Devrel Roadmap](https://github.com/gatsbyjs/gatsby/projects/10) on GitHub
5. Article sections that you or other community members would like to see
4. Article sections that you or other community members would like to see

## Reference guide overview template

Expand Down
5 changes: 2 additions & 3 deletions docs/contributing/how-to-write-a-tutorial.md
Expand Up @@ -17,9 +17,8 @@ We need tutorials to guide users of all skill levels through performing a series
Topics should be chosen based on these priorities:

1. Tutorials related to improving [key learning workflows](https://github.com/gatsbyjs/gatsby/issues/13708)
2. Tutorials listed in the "Backlog" or "To prioritize" sections of the [Learning / Devrel Roadmap](https://github.com/gatsbyjs/gatsby/projects/10) on GitHub
3. Tutorials with the [help wanted and type:documentation](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22type%3A+documentation%22) labels on GitHub
4. Tutorials that you or other community members would like to see
2. Tutorials with the [help wanted and type:documentation](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22type%3A+documentation%22) labels on GitHub
3. Tutorials that you or other community members would like to see

## Length of a tutorial

Expand Down
3 changes: 1 addition & 2 deletions docs/contributing/managing-pull-requests.md
Expand Up @@ -154,9 +154,8 @@ Every PR opened in the repository needs to be approved before it can be merged.
Typically this is:

- **gatsbyjs/themes** for certain features like Themes, Recipes, and Admin
- **gatsbyjs/learning** for documentation
- **gatsbyjs/documentation** for documentation
- **gatsbyjs/core** for any other code
- **gatsbyjs/website** for anything related to GatsbyJS.com

We also have `CODEOWNERS` set on different parts of the repo and an approval by someone in the `CODEOWNERS` for the file(s) the PR is changing can also suffice.

Expand Down

0 comments on commit 510370d

Please sign in to comment.