Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Rename developer guide to contribution guide & document changelog #1858

Merged
merged 2 commits into from
Nov 28, 2021
Merged

docs: Rename developer guide to contribution guide & document changelog #1858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4640f0e
WIP
tomkerkhove Nov 28, 2021
17f0eaf
Document changelog
tomkerkhove Nov 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion development-guide.md → CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Promitor Development Guide
# Contributing to Promitor

This guide explains the layout of the Promitor repository, along with the tools
and technologies required to develop Promitor.
Expand Down Expand Up @@ -33,6 +33,18 @@ to Promitor or modifying existing functionality, please add associated documenta
Information about how to build and run the documentation locally can be found in
the [README](docs/README.md) for the documentation.

Every PR will automatically build and deploy a preview version of the documentation for you.

## Changelog

All changes to Promitor are listed on [our changelog](https://changelog.promitor.io/) so that end-users can keep track
of changes per version over time.

Every PR should document what has changed by adding an entry to our changelog located in `changelog\content\experimental\unreleased.md`.

You can find some markup examples in `unreleased.md.template`, but every PR will automatically render a preview to make
it easier for you.

## .NET Development

Promitor is written in C# using .NET Core. To make changes to Promitor you need the
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ welcome bug reports, improvement suggestions and pull requests.
Want to see support for a scraper that is not [already supported](https://docs.promitor.io/configuration/v2.x/metrics/#supported-azure-services)?
You can contribute by [adding one yourself](adding-a-new-scraper.md)!

Information about making changes to Promitor can be found [here](development-guide.md).
Information about making changes to Promitor can be found [here](contributing.md).

### Testing Infrastructure

Expand Down
8 changes: 7 additions & 1 deletion adding-a-new-scraper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,16 @@ When the scraper supports resource discovery, the following documentation is req
2. Add scraper to supported scrapers on resource discovery configuration documentation page
`docs/configuration/v2.x/resource-discovery.md` in alphabetical order.

## Changelog

New scalers are a great additions and we should make sure that they are listed in our changelog.

Learn about our changelog in our [contribution guide](CONTRIBUTING.md#Changelog).

## See It In Action

Now that you are done, make sure you run Promitor locally so verify that it generates the correct metrics!

When opening the pull request (PR), feel free to copy the generated Prometheus metrics for review.

Learn how to run it in our [development guide](development-guide.md#running-promitor).
Learn how to run it in our [development guide](contributing.md#running-promitor).