Skip to content

Commit

Permalink
Fix Markdown Lint warnings (netdata#6664)
Browse files Browse the repository at this point in the history
* make remark access all directories

* detailed fix after autofix by remark lint

* cross check autofix for this set of files

* crosscheck more files

* crosschecking and small fixes

* crosscheck autofixed md files
  • Loading branch information
prhomhyse authored and cakrit committed Aug 15, 2019
1 parent 69172fd commit f5006d5
Show file tree
Hide file tree
Showing 245 changed files with 6,870 additions and 6,404 deletions.
31 changes: 15 additions & 16 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Expand Down Expand Up @@ -68,9 +68,8 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>

[homepage]: https://www.contributor-covenant.org


[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCODE_OF_CONDUCT&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCODE_OF_CONDUCT&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
45 changes: 24 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,29 @@ Netdata is a complex system, with many integrations for the various collectors,
#### Sponsor a collector

Netdata is all about simplicity and meaningful presentation. A "sponsor" for a collector does the following:
- Assists the devs with feedback on the charts.
- Specifies the alarms that would make sense for each metric.
- When the implementation passes QA, tests the implementation in production.
- Uses the charts and alarms in his/her day to day work and provides additional feedback.
- Requests additional improvements as things change (e.g. new versions of an API are available).

- Assists the devs with feedback on the charts.
- Specifies the alarms that would make sense for each metric.
- When the implementation passes QA, tests the implementation in production.
- Uses the charts and alarms in his/her day to day work and provides additional feedback.
- Requests additional improvements as things change (e.g. new versions of an API are available).

#### Sponsor a backend

We already support various [backends](backends) and we intend to support more. A "sponsor" for a backend:
- Suggests ways in which the information in Netdata could best be exposed to the particular backend, to facilitate meaningful presentation.
- When the implementation passes QA, tests the implementation in production.
- Uses the backend in his/her day to day work and provides additional feedback, after the backend is delivered.
- Requests additional improvements as things change (e.g. new versions of the backend API are available).

- Suggests ways in which the information in Netdata could best be exposed to the particular backend, to facilitate meaningful presentation.
- When the implementation passes QA, tests the implementation in production.
- Uses the backend in his/her day to day work and provides additional feedback, after the backend is delivered.
- Requests additional improvements as things change (e.g. new versions of the backend API are available).

#### Sponsor a notification method

Netdata delivers alarms via various [notification methods](health/notifications). A "sponsor" for a notification method:
- Points the devs to the documentation for the API and identifies any unusual features of interest (e.g. the ability in Slack to send a notification either to a channel or to a user).
- Uses the notification method in production and provides feedback.
- Requests additional improvements as things change (e.g. new versions of the API are available).

- Points the devs to the documentation for the API and identifies any unusual features of interest (e.g. the ability in Slack to send a notification either to a channel or to a user).
- Uses the notification method in production and provides feedback.
- Requests additional improvements as things change (e.g. new versions of the API are available).

## Experienced Users

Expand All @@ -75,7 +78,6 @@ We expect most contributions to be for new data collection plugins. You can read

Of course we appreciate contributions for any other part of the NetData agent, including the [daemon](daemon), [backends for long term archiving](backends/), innovative ways of using the [REST API](web/api) to create cool [Custom Dashboards](web/gui/custom/) or to include NetData charts in other applications, similarly to what can be done with [Confluence](web/gui/confluence/).


### Contributions Ground Rules

#### Code of Conduct and CLA
Expand Down Expand Up @@ -131,16 +133,18 @@ The single most important rule when writing code is this: *check the surrounding
We use several different languages and have had contributions from several people with different styles. When in doubt, you can check similar existing code.

For C contributions in particular, we try to respect the [Linux kernel style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html), with the following exceptions:
- Use 4 space indentation instead of 8
- We occassionally have multiple statements on a single line (e.g. `if (a) b;`)
- Allow max line length of 120 chars
- Allow opening brace at the end of a function declaration: `function() {`.

- Use 4 space indentation instead of 8
- We occassionally have multiple statements on a single line (e.g. `if (a) b;`)
- Allow max line length of 120 chars
- Allow opening brace at the end of a function declaration: `function() {`.

### Your first pull request

There are several guides for pull requests, such as the following:
- https://thenewstack.io/getting-legit-with-git-and-github-your-first-pull-request/
- https://github.com/firstcontributions/first-contributions#first-contributions

- <https://thenewstack.io/getting-legit-with-git-and-github-your-first-pull-request/>
- <https://github.com/firstcontributions/first-contributions#first-contributions>

However, it's not always that simple. Our [PR approval process](#pr-approval-process) and the several merges we do every day may cause your fork to get behind the Netdata master. If you worked on something that has changed in the meantime, you will be required to do a git rebase, to bring your fork to the correct state. A very easy to follow guide on how to do it without learning all the intricacies of GitHub can be found [here](https://medium.com/@ruthmpardee/git-fork-workflow-using-rebase-587a144be470)

Expand All @@ -154,5 +158,4 @@ We also have a series of automated checks running, such as linters to check code

One special type of automated check is the "WIP" check. You may add "[WIP]" to the title of the PR, to tell us that the particular request is "Work In Progress" and should not be merged. You're still not done with it, you created it to get some feedback. When you're ready to get the final approvals and get it merged, just remove the "[WIP]" string from the title of your PR and the "WIP" check will pass.


[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTING&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTING&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
148 changes: 75 additions & 73 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,115 +17,117 @@ contributions for any other purpose.

## copyright license

The Contributor (*you*) grants Netdata Inc. a perpetual, worldwide, non-exclusive,
The Contributor (_you_) grants Netdata Inc. a perpetual, worldwide, non-exclusive,
no-charge, royalty-free, irrevocable copyright license to reproduce,
prepare derivative works of, publicly display, publicly perform, sublicense,
and distribute his contributions and such derivative works.

## copyright transfer

The Contributor (*you*) hereby assigns Netdata Inc. copyright in his
The Contributor (_you_) hereby assigns Netdata Inc. copyright in his
contributions, to be licensed under the same terms as the rest of the code.

> *Note: this means we may re-license Netdata (your contributions included)
> _Note: this means we may re-license Netdata (your contributions included)
> any way we see fit, without asking your permission.
> We intend to keep the Netdata agent forever FOSS.
> But open-source licenses have significant differences and in our attempt to
> help Netdata grow we may have to distribute it under a different license.
> For example, CNCF, the Cloud Native Computing Foundation, requires Netdata
> to be licensed under Apache-2.0 for it to be accepted as a member of the
> Foundation. We want to be free to do it.*
> Foundation. We want to be free to do it._
## original work

The Contributor (*you*) represent that each of his contributions is his
The Contributor (_you_) represent that each of his contributions is his
original creation and that he is legally entitled to grant the above license.

> *Note: if you are committing third party code, please make sure the third party
> _Note: if you are committing third party code, please make sure the third party
> license or any other restrictions are also included with your commits.
> Netdata includes many third party libraries and tools and this is not a
> problem, provided that the license of the third party code is compatible with
> the one we use for Netdata.*
> the one we use for Netdata._
## signature

Since Sep 17th 2018, we use https://cla-assistant.io/netdata/netdata for signing the CLA, on all pull requests.
Since Sep 17th 2018, we use <https://cla-assistant.io/netdata/netdata> for signing the CLA, on all pull requests.
Old contributors can sign the CLA at any time using this link.

## HISTORICAL SIGNATURES
(they have been imported to https://cla-assistant.io/netdata/netdata already)

The Contributor (*you*) signs this agreement by adding his personal data in
(they have been imported to <https://cla-assistant.io/netdata/netdata> already)

The Contributor (_you_) signs this agreement by adding his personal data in
this document and committing it to the project repo
(the same way contributions are submitted to the project).

By signing once, all contributions (past and future) of The Contributor (*you*),
By signing once, all contributions (past and future) of The Contributor (_you_),
are subject to this agreement.

> *Note: so you have to:*
> 1. add your github username and name in this file
> 2. commit it to the repo with a PR, using the same github username, or include this change in your first PR.
> _Note: so you have to:_
>
> 1. add your github username and name in this file
> 2. commit it to the repo with a PR, using the same github username, or include this change in your first PR.
# Netdata contributors

This is the list of contributors that have signed this agreement:

username|name|email (optional)
:--------:|:----:|:----------------
@lets00|Luís Eduardo|[email protected]
@ktsaou|Costa Tsaousis|[email protected]
@tycho|Steven Noonan|[email protected]
@philwhineray|Phil Whineray|
@paulfantom|Paweł Krupa|[email protected]
@Ferroin|Austin S. Hemmelgarn|[email protected]
@glensc|Elan Ruusamäe|
@l2isbad|Ilya Mashchenko|[email protected]
@rlefevre|Rémi Lefèvre|
@vlvkobal|Vladimir Kobal|[email protected]
@simonnagl|Simon Nagl|
@manosf|Emmanouil Fokas|[email protected]
@user501254|Ashesh Singh|[email protected]
@t-h-e|Stefan Forstenlechner|
@facetoe|Facetoe|
@ntlug|Christopher Cox|[email protected]
@alonbl|Alon Bar-Lev|[email protected]
@Wing924|Wei He|[email protected]
@NeonSludge|Kirill Buev|[email protected]
@kmlucy|Kyle Lucy|[email protected]
@RicardoSette|Ricardo Sette|[email protected]
@383c57|Shinichi Tagashira|
@davidak|David Kleuker|[email protected]
@ccremer|Christian Cremer|
@jimcooley|Jim Cooley|[email protected]
@Chocobo1|Mike Tzou|
@vinyasmusic|Vinyas Malagaudanavar|[email protected]
@cosmix|Dimosthenis Kaponis|
@shadycuz|Levi Blaney|[email protected]
@Flums|Philip Gabrielsen|[email protected]
@domschl|Dominik Schlösser|[email protected]
@tioumen|Guillaume Hospital|
@arch273|Jacob Ayres
@x4FF3|David Fuellgraf|
@jasonwbarnett|Jason Barnett|
@ecowed|Ed Wade|
@wungad|Rob Man|
@rda0|Sven Mäder|[email protected]
@alibo|Ali Borhani|[email protected]
@Nani-o|Sofiane Medjkoune|[email protected]
@n0guest|Evgeniy K.|[email protected]
@amichelic|Adalbert Michelic|
@abalabahaha|abalabahaha|[email protected]
@illes|Illes S.|
@plasticrake|Patrick Seal
@jonfairbanks|Jon Fairbanks
@pjz|Paul Jimenez|[email protected]
@jgrossiord|Julien Grossiord|[email protected]
@pohzipohzi|Poh Zi How
@vladmovchan|Vladyslav Movchan|[email protected]
@gmosx|George Moschovitis
@adherzog|Adam Herzog|[email protected]
@skrzyp1|Jerzy S.|
@akwan|Alan Kwan|
@underhood|Timotej Šiškovič|

[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTORS&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
|username|name|email (optional)|
|:------:|:--:|:---------------|
|@lets00|Luís Eduardo|[email protected]|
|@ktsaou|Costa Tsaousis|[email protected]|
|@tycho|Steven Noonan|[email protected]|
|@philwhineray|Phil Whineray||
|@paulfantom|Paweł Krupa|[email protected]|
|@Ferroin|Austin S. Hemmelgarn|[email protected]|
|@glensc|Elan Ruusamäe||
|@l2isbad|Ilya Mashchenko|[email protected]|
|@rlefevre|Rémi Lefèvre||
|@vlvkobal|Vladimir Kobal|[email protected]|
|@simonnagl|Simon Nagl||
|@manosf|Emmanouil Fokas|[email protected]|
|@user501254|Ashesh Singh|[email protected]|
|@t-h-e|Stefan Forstenlechner||
|@facetoe|Facetoe||
|@ntlug|Christopher Cox|[email protected]|
|@alonbl|Alon Bar-Lev|[email protected]|
|@Wing924|Wei He|[email protected]|
|@NeonSludge|Kirill Buev|[email protected]|
|@kmlucy|Kyle Lucy|[email protected]|
|@RicardoSette|Ricardo Sette|[email protected]|
|@383c57|Shinichi Tagashira||
|@davidak|David Kleuker|[email protected]|
|@ccremer|Christian Cremer||
|@jimcooley|Jim Cooley|[email protected]|
|@Chocobo1|Mike Tzou||
|@vinyasmusic|Vinyas Malagaudanavar|[email protected]|
|@cosmix|Dimosthenis Kaponis||
|@shadycuz|Levi Blaney|[email protected]|
|@Flums|Philip Gabrielsen|[email protected]|
|@domschl|Dominik Schlösser|[email protected]|
|@tioumen|Guillaume Hospital||
|@arch273|Jacob Ayres||
|@x4FF3|David Fuellgraf||
|@jasonwbarnett|Jason Barnett||
|@ecowed|Ed Wade||
|@wungad|Rob Man||
|@rda0|Sven Mäder|[email protected]|
|@alibo|Ali Borhani|[email protected]|
|@Nani-o|Sofiane Medjkoune|[email protected]|
|@n0guest|Evgeniy K.|[email protected]|
|@amichelic|Adalbert Michelic||
|@abalabahaha|abalabahaha|[email protected]|
|@illes|Illes S.||
|@plasticrake|Patrick Seal||
|@jonfairbanks|Jon Fairbanks||
|@pjz|Paul Jimenez|[email protected]|
|@jgrossiord|Julien Grossiord|[email protected]|
|@pohzipohzi|Poh Zi How||
|@vladmovchan|Vladyslav Movchan|[email protected]|
|@gmosx|George Moschovitis||
|@adherzog|Adam Herzog|[email protected]|
|@skrzyp1|Jerzy S.||
|@akwan|Alan Kwan||
|@underhood|Timotej Šiškovič||

[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2FCONTRIBUTORS&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
Loading

0 comments on commit f5006d5

Please sign in to comment.