Skip to content

Commit 417ee5d

Browse files
committed
Added Google Season of Docs ideas
1 parent fbdf74f commit 417ee5d

File tree

15 files changed

+192
-360
lines changed

15 files changed

+192
-360
lines changed

content/internships/project-ideas-collection/add-audio/contents.lr

-37
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: Improve CC Catalog API repo documentation for potential contributors
6+
---
7+
problem:
8+
We'd like to improve our documentation for potential contributors in the `cccatalog-api` repository. This repository includes a few different projects and we'd like to improve documentation for all of them.
9+
---
10+
expected_outcome:
11+
* Detailed code and architecture documentation available in the GitHub repository.
12+
---
13+
internship_tasks:
14+
* Work with CC’s backend engineer to come up with a plan for the documentation.
15+
* Write documentation and create pull requests to get it merged.
16+
* If the documentation requires deployment, work with the CC team to deploy the documentation publicly.
17+
---
18+
application_tips:
19+
* Demonstrate your familiarity with the codebase and existing documentation.
20+
* Explain how you'd like to refactor or expand the documentation in detail.
21+
---
22+
resources:
23+
* [CC Catalog API documentation](https://api.creativecommons.engineering/v1/)
24+
* [CC Catalog API code](https://github.com/creativecommons/cccatalog-api)
25+
* [Divio's documentation best practices](https://documentation.divio.com/)
26+
---
27+
skills_recommended: Python, Writing
28+
---
29+
mentors: Alden Page
30+
---
31+
difficulty: Medium
32+
---
33+
filter_value: difficulty-medium skill-python skill-writing
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: CC Catalog API usage guide
6+
---
7+
problem:
8+
The [CC Catalog API documentation](https://api.creativecommons.engineering/v1/) is currently entirely auto-generated. While it's good, basic, API documentation, we'd like to make it more user friendly and provide how-tos, examples, and a bit more narrative.
9+
---
10+
expected_outcome:
11+
* Published API documentation should include auto-generated documentation as well as narrative elements.
12+
* API documentation should use Vocabulary, CC's design system if feasible.
13+
---
14+
internship_tasks:
15+
* Work with CC’s backend engineer to come up with a plan for the documentation.
16+
* Build upon the auto-generated documentation and find a way to include narrative elements.
17+
* Integrate with Vocabulary if feasible.
18+
* Write documentation and create pull requests to get it merged.
19+
* Work with the CC team to deploy the documentation publicly.
20+
---
21+
application_tips:
22+
* Demonstrate your familiarity with the codebase and existing documentation.
23+
* Explain how you'd like to refactor or expand the documentation in detail.
24+
---
25+
resources:
26+
* [CC Catalog API documentation](https://api.creativecommons.engineering/v1/)
27+
* [CC Catalog API code](https://github.com/creativecommons/cccatalog-api)
28+
* [GoodRx API guide](https://www.goodrx.com/developer) (example API guide)
29+
* [Divio's documentation best practices](https://documentation.divio.com/)
30+
* [vocabulary GitHub repo](https://github.com/creativecommons/vocabulary)
31+
* [vocabulary documentation](https://cc-vocabulary.netlify.app/)
32+
* [Introducing Vocabulary blog post on CC blog](https://creativecommons.org/2019/12/13/cc-vocabulary-web-design-system/)
33+
* [Posts about Vocabulary on the CC open source blog](https://opensource.creativecommons.org/blog/categories/cc-vocabulary/)
34+
---
35+
skills_recommended: Python, Writing
36+
---
37+
mentors: Alden Page, Kriti Godey
38+
---
39+
difficulty: Medium
40+
---
41+
filter_value: difficulty-medium skill-python skill-writing

content/internships/project-ideas-collection/catalog-expansion/contents.lr

-30
This file was deleted.

content/internships/project-ideas-collection/cc-search-accessibility/contents.lr

-48
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
_model: project-idea
2+
---
3+
_hidden: yes
4+
---
5+
title: Improve CC Search documentation for potential contributors
6+
---
7+
problem:
8+
We'd like to improve our documentation for potential contributors in the `cccatalog-frontend` repository.
9+
---
10+
expected_outcome:
11+
* Detailed code and architecture documentation available in the GitHub repository.
12+
---
13+
internship_tasks:
14+
* Work with CC’s frontend engineer to come up with a plan for the documentation.
15+
* Write documentation and create pull requests to get it merged.
16+
* If the documentation requires deployment, work with the CC team to deploy the documentation publicly.
17+
---
18+
application_tips:
19+
* Demonstrate your familiarity with the codebase and existing documentation.
20+
* Explain how you'd like to refactor or expand the documentation in detail.
21+
---
22+
resources:
23+
* [CC Search code](https://github.com/creativecommons/cccatalog-frontend)
24+
* [CC Search](https://search.creativecommons.org/)
25+
* [Divio's documentation best practices](https://documentation.divio.com/)
26+
---
27+
skills_recommended: JavaScript, Writing
28+
---
29+
mentors: Breno Ferreira
30+
---
31+
difficulty: Medium
32+
---
33+
filter_value: difficulty-medium skill-javascript skill-writing

content/internships/project-ideas-collection/legal-database/contents.lr

-42
This file was deleted.

content/internships/project-ideas-collection/linked-commons/contents.lr

-36
This file was deleted.

0 commit comments

Comments
 (0)