Augur is looking for Google Summer of Docs (GSoD) applicants!
Create, Advance, and Clarify Documentation for Augur
Augur is a CHAOSS toolset for ontologically consistent data science and analytics, with fully traceable data provenance from the report, back through the analysis, persistence, and data source. It is in some sense, a single piece of software. In another sense, Augur has 18 “workers” individually focused workers. Our worker goals include:
- high speed data capture and persistence, each of which has configurable parameters related to its role.
- Information retrieval, artificial intelligence, and data mining (including, topic modeling, clustering, natural language processing, sentiment analysis, and other algorithms)
- Notification: Augur’s user interface design does contain a “dashboard”, but our focus is on notification through push mechanisms.
- User Identification reconciliation. While each worker that gathers data first checks platform APIs and our own database to see if a user already exists, we also have one worker focused on verifying the map we create. We also store affiliation data, and provide a view of contribution level outside of each project’s contributors.
Knowledge/Skills Involved: Python, but we have enough worked examples, and a growing community that there is ample opportunity for the developer to learn on the job. It’s also important to more clearly explain Augur’s advanced, distributed architecture, which allows each worker to run on a different computer, or virtual computer. The Housekeeper, Broker, and Configuration Manager facilitate this process.
Aims of the project:
Augur is now focused on developing tools that support increased Diversity, Equity, and Inclusion in Open Source Software. Our documentation work on this project will provide the writer a chance to put their own stamp, related to this theme, throughout existing, and future documentation for Augur. Some steps along the way probably include:
- Interview key contributors and maintainers to clarify existing documentation at https://oss-augur.readthedocs.io/en/master/
- Use Restructured Text to update, enhance, expand, and organize existing documentation.
- If time permits, develop “job aid” documentation for users with particular roles (Sean Goggins can help you learn what a job Aid is; he taught the course for graduate students at the University of Missouri when he was a Ph.D Student). Possible roles include:
- First time developer.
- Community Manager/OSPO Manager (likely a Docker focused installation)
- New Contributor