Thanks for considering to contribute to o11y.love :)
You can fork the project https://gitlab.com/everyonecancontribute/observability/o11y.love and send a merge request to review.
Proposals and Feedback¶
You can always fork the project and suggest a change in a Merge Request as a draft.
If you've found a problem, or miss something, you can also open a new issue in the project following the template.
Preview in MkDocs¶
This project uses MkDocs with the Material theme. In order to render a preview, use the following options.
If you are using a tablet or mobile, we recommend to use Gitpod in your browser.
Open the project or your fork and change the selector from
Web IDE to
Alternatively, use https://gitpod.io/#https://gitlab.com/everyonecancontribute/observability/o11y.love
Install Docker and run the container with port-forwarding to localhost:8000. The source directory is mapped into the container.
Local source environment¶
Install Python 3.9+ and pip, for example with Homebrew on macOS.
o11y.love requires MkDocs themes and plugins which are defined in
requirements.txt. Install them with the following command:
Depending on your environment, the
pip command is called
You can run MkDocs with the following command:
More verbose output for debugging:
mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.
Add items to topics¶
For adding tools and projects, follow the existing structure.
Example from topics/metrics.md.
## Tools ### Prometheus - [Website](https://prometheus.io/) - [Documentation](https://prometheus.io/docs/introduction/overview/) #### Facts - Started in 2012 - [Open Source](https://github.com/prometheus) - [CNCF graduated project in 2018](https://www.cncf.io/announcements/2018/08/09/prometheus-graduates/) #### Hot Topics - [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) query language. - [Metric Types](https://prometheus.io/docs/concepts/metric_types/) - [Exporters](https://prometheus.io/docs/instrumenting/exporters/) where Prometheus can scrape metrics from. - [Instrumentation](https://prometheus.io/docs/instrumenting/clientlibs/) for your app source, exposing `/metrics`.
Add new topics¶
Consider copying an existing topic, and add it to the menu in the
Add Learning Resources¶
When adding a training resource, please ensure that you have taken the training, and can recommend the training by adding your name to the table.