Open Source Internships: Project Ideas

This is the project idea list for the current round of open source internships at Creative Commons.

CC Catalog API usage guide

Difficulty

Medium

Skills recommended

Python, Writing

Mentors

Alden Page, Kriti Godey

The Problem

The CC Catalog API documentation 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.

Expected Outcome

  • Published API documentation should include auto-generated documentation as well as narrative elements.
  • API documentation should use Vocabulary, CC's design system if feasible.

Internship Tasks

  • Work with CC’s backend engineer to come up with a plan for the documentation.
  • Build upon the auto-generated documentation and find a way to include narrative elements.
  • Integrate with Vocabulary if feasible.
  • Write documentation and create pull requests to get it merged.
  • Work with the CC team to deploy the documentation publicly.

Application Tips

  • Demonstrate your familiarity with the codebase and existing documentation.
  • Explain how you'd like to refactor or expand the documentation in detail.

Resources

Back to the Project list

Improve CC Catalog API repo documentation for potential contributors

Difficulty

Medium

Skills recommended

Python, Writing

Mentors

Alden Page

The Problem

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.

Expected Outcome

  • Detailed code and architecture documentation available in the GitHub repository.

Internship Tasks

  • Work with CC’s backend engineer to come up with a plan for the documentation.
  • Write documentation and create pull requests to get it merged.
  • If the documentation requires deployment, work with the CC team to deploy the documentation publicly.

Application Tips

  • Demonstrate your familiarity with the codebase and existing documentation.
  • Explain how you'd like to refactor or expand the documentation in detail.

Resources

Back to the Project list

Vocabulary usage guide

Difficulty

Medium

Skills recommended

HTML, CSS, JavaScript, Writing

Mentors

Dhruv Bhanushali, Hugo Solar

The Problem

Vocabulary is CC's web design system. We'd like to build a really robust usage guide for Vocabulary so that anyone wanting to build a site using Vocabulary knows what components are available, how to use them, how to manage the build process, etc.

Expected Outcome

  • Published usage guidelines for all components of Vocabulary that complement the existing storybook.
  • A better landing page for Vocabulary, Vue Vocabulary, and Fonts.
  • Integrated documentation for all three components of Vocabulary.
  • Documentation and landing page should also use Vocabulary.

Internship Tasks

  • Work with CC's web/frontend developers and Vocabulary core committers to come up with a plan for the documentation.
  • Write documentation.
  • Work with the CC team to deploy the documentation publicly.

Application Tips

  • Demonstrate your familiarity with the codebase and existing documentation.
  • Explain how you'd like to refactor or expand the documentation in detail.

Resources

Back to the Project list

WordPress base theme usage guide

Difficulty

Medium

Skills recommended

WordPress, Writing

Mentors

Hugo Solar

The Problem

We have created a new WordPress base theme for all CC WordPress websites. We plan to make child themes for each CC WordPress website that uses this theme. We'd like documentation for how to use and customize the WordPress base theme and how to create a new website using a child theme.

Expected Outcome

  • Published usage guidelines for the WordPress base theme.

Internship Tasks

  • Work with CC's web developer to come up with a plan for the documentation.
  • Write documentation.
  • Work with the CC team to deploy the documentation publicly.

Application Tips

  • Demonstrate your familiarity with the codebase and existing documentation.
  • Explain how you'd like to refactor or expand the documentation in detail.

Resources

Back to the Project list

Original Ideas

We are open to original ideas for documentation improvements.

Please talk to us on the #cc-dev-internships channel on Slack or via the mailing list to find a mentor for the project before submitting your proposal.

Back to the Project list