Outreachy

The OpenTracing and Jaeger projects are happy to announce our participation in the Outreachy program, running from May 2018 to August 2018.

Please see the main program page for the general information about the program, such as its purpose, timeline, eligibility requirements, and how to apply.

What is OpenTracing

OpenTracing is a vendor-neutral open standard for distributed tracing. For the motivation behind OpenTracing, we recommend watching the presentations available at the page Talks and Videos.

What is Jaeger

Jaeger is a concrete set of tracers and a trace storage backend, for usage on applications and microservices instrumented with OpenTracing. Its GitHub main readme is a good starting point to understand what is Jaeger and how to start using it.

Schedule

Coordination

The coordinators can be contacted at any time. The easiest way is to send a message to the mailing list of either OpenTracing or Jaeger, as both coordinators are present on both mailing lists:

Another option is to use Gitter, which is the chat platform used by both the OpenTracing and Jaeger projects:

Mentors

Similar to contacting the coordinators, the mentors can be contacted at any time either by sending messages to the mailing lists or Gitter channels.

Interested in becoming a mentor? Contact one of the coordinators!

Do you have an idea for a task that is suitable for this program? Contact the mentors or coordinators! Or even better, volunteer for mentoring an intern to work on your idea!

Contribute

As part of the application process, the Outreachy program recommends that candidates make small contributions to the project they intend to apply for.

For this round, we are looking for an intern to help us on the documentation side of the projects. As such, we would like to ask candidates to finish the task “Set up Documentation Environment” and one of the other two tasks.

The tasks are relevant for any repository found in any of the following organizations:

Set up Documentation Environment

Set up your development environment for the OpenTracing docs repo and verify that you understand the workflow by submitting a small change. See CONTRIBUTING.md

Set up your development environment for JaegerTracing docs repo and verify that you understand the workflow by submitting a small change. See README.md

Find a repo whose README file does not list the open source license

Find a repo that does not have a README file

Write a README file that includes at least the following information:

  1. The name of the repository.
  2. A short description of what is in the repository
  3. The license that the covers the contents of the repository.

Internship tasks

Mentor: Julie Stickler

All of the following tasks are in the context of the internship. While all items will be used during the evaluation, the first two tasks are “mandatory” to consider the internship “successful”.

Contributor Docs

Document any additional steps that you needed to perform in order to get your system configured that were not covered in the instructions linked from these pages. (That is, if there is a link on the page, there is no need to duplicate the instructions from the link, as long as they work.)

Developers tend to work in a Linux environment. Technical Writers are sometimes more familiar with other operating systems. If you are new to Linux or are working on a Mac or Windows environment, your contribution might help other writers who want to contribute to an Open Source project.

Standardize README files

Standardize the README files across the repos. Watch Ben Hall’s talk about the Art of Documentation and the README

Do some research into Read Me templates:

  1. Create a standardized template
  2. Update all the OpenTracing Repos to use the README template
  3. Update all the JaegerTracing Repos to use the README template
  4. Readme files for Docker Hub

Small Fixes to existing docs

Select a file and fix any spelling errors, grammatical errors, or broken links. Common errors may include spelling mistakes, subject/verb agreement errors, and missing articles (a, an, the).

Be sure to distinguish between actual spelling errors and names of components, other open source projects, or technologies (which can often look like misspellings or capitalization errors)

  1. Fix a typo
  2. Make a fix on the web site
  3. Make a fix in the documentation

Testing existing docs

Test the existing docs to see if they can be followed. Revise to correct errors and add missing information.

Reference: jaegertracing/jaeger#472

Docs site needs an FAQ section

Monitor communication channels and issues and add new topics to the FAQ

Create a UI page listing known integrations & instrumentation libraries

opentracing/opentracing.io#192

Document feature matrix for client libraries

jaegertracing/jaeger#384

Previous programs

OpenTracing and Jaeger participated in the following Outreachy programs:

Code of Conduct

Both OpenTracing and Jaeger are part of the Cloud Native Computing Foundation (CNCF) and have adopted its Code of Conduct.

We are a Cloud Native Computing Foundation member project.