Potential Outreachy Project: Augur Documentation Inclusivity

[sgoggins]

This issue simply describes what one potential Outreachy project would be. There is nothing to do in this issue with respect to the application period.

Project Description

Augur Documentation Inclusivity

Augur is a CHAOSS Software project that focuses on the collection and analysis of open-source software health and sustainability data.

Augur’s main focus is to measure the overall health and sustainability of open source projects, as these types of projects are system critical for nearly every software organization or company. We do this by gathering data about a project’s repositories, normalizing that into our data model to provide useful metrics about your project’s health. For example, one of our metrics is Burstiness (How are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project?), which can paint a picture about a project’s focus as well as gain insight as to the potential stability of a project, and how its typical cycle of updates occurs. There are many more useful metrics, and you can find a full list of them here.

This software is developed as part of the CHAOSS (Community Health Analytics Open Source Software) project, and many of our metrics are implementations of the metrics defined by our awesome community. You can find more information about how to get involved on the CHAOSS website. If you want to see augur in action, you can view CHAOSS’s own augur instance.
The Project

This project would focus on updating Augur's documentation to incorporate more inclusive language and to more accurately reflect the organization of information a newcomer requires to contribute to the project. A current version of Augur's documentation is found here: https://oss-augur.readthedocs.io/en/main/

Accomplishing these aims would require the intern to approach Augur as a newcomer, identify non-inclusive language, areas of confusion, and potential areas of improvement in clarity.

We think this project is potentially exciting to an intern interested in open source software health and sustainability because, through the process of updating documentation, there is an opportunity to understand CHAOSS metrics and metrics models more fully, and create direct links between the metrics and metrics Models Augur provides, and their corresponding CHAOSS definitions. In short, this project is an opportunity for deep engagement with the CHAOSS community.
Internship Tasks

These are generally described above. A detailed plan will be developed in collaboration with the intern with the aim of creating the maximal alignment between an intern's skills and interests, and the goals of the project.
Intern Benefits

We think this project is potentially exciting to an intern interested in open source software health and sustainability because, through the process of updating documentation, there is an opportunity to understand CHAOSS metrics and metrics models more fully, and create direct links between the metrics and metrics Models Augur provides, and their corresponding CHAOSS definitions. In short, this project is an opportunity for deep engagement with the CHAOSS community.
Project Contribution Information

As part of the application process, all applicants must make at least one contribution to be accepted as an intern for this project. Only applicants who make a contribution will be eligible to be accepted as interns.

Applicants can contribute to this project through the project repository or contribution page. The project uses an issue tracker to keep information about bugs to fix, project features to implement, documentation to write, and more. Applicants can look for newcomer-friendly issues to use for their first contributions by looking for the following issue tags in the project issue tracker: Good First Issue

Opening issues related to documentation is the easiest way to make an applicant contribution. This can include identifying specific areas where improvements noted in the project description can be made.

A pull request modifying documentation is also a good approach, though we recognize that part of the internship will be working with the project team to understand the technical tools used. Since prior knowledge of these tools is not required, we do not require this type of application period contribution.
How do I work with the CHAOSS community?

Outreachy applicants can get help and feedback from both mentors and community members. Community members discuss their contributions in a public chat. Outreachy applicants can often learn from those discussions.

Please introduce yourself on the public project chat:

Slack - [Follow this link](https://join.slack.com/t/chaoss-workspace/shared_invite/zt-r65szij9-QajX59hkZUct82b0uACA6g) to join this project's public chat.

Simply join, and introduce yourself in our Newcomers channel!

Outreachy mentors will often be in the community public chat. The project mentor's usernames are: s,
Who will I work with?

Each Outreachy intern works remotely with one or more mentors. Most Outreachy mentors only work with one intern per round. Mentors are your guides in learning more about free and open source software, technical and non-technical skills, and will always be there when you get stuck.

During this internship project, you'll be interacting with a team of 50-100 people. The project has been accepting contributions from people from around the world for more than 2 years.

You'll be working with the following mentor:
Sean P. Goggins

Personal info:

Pronouns: [they/them/theirs](http://pronoun.is/they)
Timezone: America/Chicago
Location: Columbia, MO

Contact info:

Personal email: "Sean P. Goggins" <outdoors@acm.org>
GitHub profile: https://github.com/sgoggins
Blog: http://www.seangoggins.net/blog/
Twitter profile: https://twitter.com/sociallycompute

Each Outreachy mentor will have a different mentorship style, a preferred way to contact them, and different ways of working with interns. Sean P. Goggins's mentorship style is: Collaborative, with regular checkins that are more like working together than supervision.

Outreachy mentors are required to be experienced contributors to free and open source software (FOSS). Sean P. Goggins has contributed to this team for more than 2 years. This mentor has made the following contributions to this team or other FOSS communities: I co-founded it, have been active in it throughout its existance, and am the maintainer for the software project Augur.

You'll be able to find this mentor on the FOSS community communication channel under the username: s
How do I get help?

The community members and the project mentor(s) are your guides to introduce you to the project community and contribution norms. Mentors are here to help answer your questions, encourage you, and help you when you get stuck.

You should try to ask your questions on public project channels before asking mentors or coordinators questions privately. Often you'll get an answer faster if you ask on the public communication channels, rather than waiting for a mentor to answer your email. Applicants often have the same questions, so asking them in a public place helps other people.

Try to make your questions concrete "I'm having trouble installing X and I've tried Y but I get Z error message". If you are having trouble figuring out how to make a contribution, please state where you looked for contribution tasks. For example, "I'm trying to make a contribution to X project. I looked in the Y repository for issues marked newcomer-friendly, but they all seem to be claimed by other Outreachy applicants. Can you point me to an issue that involves Z?"

When you've exhausted all other avenues of communication, you can reach out to the community's coordinator. Each FOSS community has one or more coordinators. The CHAOSS coordinator(s) are "Matt Germonprez" germonprez@gmail.com, "Sean P. Goggins" outdoors@acm.org

If you're having trouble reaching both the mentors and the coordinators, you can contact the Outreachy mentors mailing list.

[ElizabethN]

I'm closing this, as the Outreachy deadline has passed.