|
| 1 | +_model: project-idea |
| 2 | +--- |
| 3 | +_hidden: yes |
| 4 | +--- |
| 5 | +title: Create Media Attribution and License Plugin for WordPress |
| 6 | +--- |
| 7 | +problem: |
| 8 | +The current existing Creative Commons WordPress plugin has feature drift and |
| 9 | +technical debt that make it a challenge to sensibly expand/revise. At the core |
| 10 | +of desired uses, this new WordPress plugin needs a reliable and succinct way to |
| 11 | +add Attribution and Licensing information to a Media item within the Media |
| 12 | +Library at initial upload. This modification/extension of the Media item’s |
| 13 | +"meta field information" needs to be stable and clear enough to enable future |
| 14 | +expansions in featureset into other areas of the WordPress backend interface. |
| 15 | +--- |
| 16 | +expected_outcome: |
| 17 | +Building from a strategy of simplistic and necessary structure and |
| 18 | +functionality, a new plugin would be created that extends the fields for a |
| 19 | +Media item to include License and Attribution information. |
| 20 | +--- |
| 21 | +contributor_tasks: |
| 22 | +Contributor will follow an approach that is simple to maintain, and possible to |
| 23 | +extend in the future. Users can upload items in at least four ways, and ideally |
| 24 | +all four would be factored into this plugin: |
| 25 | +- through the Media Library directly |
| 26 | +- through the TinyMCE editor “Add Media” button when utilizing the Classic |
| 27 | + Editor |
| 28 | +- when adding an image to a “featured image” or similar field in the Classic |
| 29 | + Editor |
| 30 | +- through any Gutenberg editor block that utilizes an image/file attachment |
| 31 | + mechanism. |
| 32 | + |
| 33 | +Each of these routes should have the ability to input and modify this |
| 34 | +additional meta field information about the item. The plugin should utilize |
| 35 | +well structured PHP generally. More specifically when solving for Gutenberg |
| 36 | +and/or TinyMCE adequate and sensible choices in JavaScript should be utilized. |
| 37 | +All code should be well documented, and specific code interacting with the |
| 38 | +Classic editor vs. Gutenberg editor contexts should be well compartmentalized. |
| 39 | +The Contributor will also set up a custom Docker configuration in accordance |
| 40 | +with other WP + Docker setups utilized by CC, specifically for the build and |
| 41 | +testing of the plugin. |
| 42 | +--- |
| 43 | +application_tips: |
| 44 | +- Engage with the CC Legal Tools repositories (issues, pull requests) |
| 45 | +- Be helpful and welcoming (e.g. answer other contributors’ questions on Slack) |
| 46 | +- [Applicant Guide](/programs/applicant-guide/) |
| 47 | +--- |
| 48 | +resources: |
| 49 | +- [CC Attribution Guidelines](https://wiki.creativecommons.org/wiki/Recommended_practices_for_attribution) |
| 50 | +- [CC Licenses](https://creativecommons.org/share-your-work/cclicenses/) |
| 51 | +- [Classic Editor + TinyMCE](https://codex.wordpress.org/TinyMCE) |
| 52 | +- [Docker](https://www.docker.com/) |
| 53 | +- [Docker in vocabulary-theme](https://github.com/creativecommons/vocabulary-theme?tab=readme-ov-file#docker-containers) |
| 54 | +- [Gutenberg](https://developer.wordpress.org/block-editor/explanations/architecture/key-concepts/) |
| 55 | +- [WordPress Plugin Development](https://developer.wordpress.org/plugins/intro/) |
| 56 | +- [WordPress Theme Development](https://codex.wordpress.org/Theme_Development) |
| 57 | +--- |
| 58 | +skills_recommended: |
| 59 | +- CSS |
| 60 | +- Docker |
| 61 | +- Git |
| 62 | +- HTML |
| 63 | +- JavaScript |
| 64 | +- PHP |
| 65 | +- WordPress (including Classic Editor, Gutenberg Editor/React.js, Plugins, and |
| 66 | + Themes) |
| 67 | +--- |
| 68 | +lead: |
| 69 | +- Sara |
| 70 | +--- |
| 71 | +difficulty: High |
| 72 | +--- |
| 73 | +size: Large (~350 hours) |
| 74 | +--- |
| 75 | +filter_value: difficulty-high skill-css skill-git skill-javascript skill-php skill-wordpress |
0 commit comments