User story & summary:
As a Wikimedia Developer or WMF Engineer, I want to understand how I should set up my project so that it will be compatible with Community Configuration 2.0.
Background & research:
This task is important because Community Configuration 2.0 will only be successful if it is widely adopted, and other teams and engineers will only utilize Community Configuration if it is understandable and relatively straightforward to utilize.
Acceptance Criteria:
- Create initial basic documentation draft
- Review documentation with Growth engineers
- Review documentation draft with Technical Documentation Team You can schedule an appointment with the Documentation team here.
- Create subtasks of further documentation needs
Helpful links
- Instructions for setting up JSDoc: https://www.mediawiki.org/wiki/JSDoc
- Task for looking into documenting Vue components with JSDoc: https://phabricator.wikimedia.org/T360456
- There’s not much information about how to set up Doxygen for PHP docs, but the basics are here: https://www.mediawiki.org/wiki/Continuous_integration/Entry_points#PHP_Documentation