Add community link to readme (#9602)
* Add community link to readme and contributing * Update CONTRIBUTING.md small typos fixed * Update CONTRIBUTING.md fix missing link to community in contributing.md * Update CONTRIBUTING.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com> Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
This commit is contained in:
Zack Shoylev
GitHub
parent
4464bcc1cc
commit
af38654ff1
|
|
@ -11,8 +11,8 @@ Thank you for considering contributing to Netdata.
|
|||
|
||||
We love to receive contributions. Maintaining a platform for monitoring everything imaginable requires a broad understanding of a plethora of technologies, systems and applications. We rely on community contributions and user feedback to continue providing the best monitoring solution out there.
|
||||
|
||||
There are many ways to contribute, with varying requirements of skills, explained in detail in the following sections.
|
||||
Specific GitHub issues we need help with can be seen [here](https://github.com/netdata/netdata/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22). Some of them are also labeled as "good first issue".
|
||||
There are many ways to contribute, with varying requirements of skills, explained in detail in the following sections.
|
||||
Specific GitHub issues we need help with can be seen [here](https://github.com/netdata/netdata/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22). Some of them are also labeled as "good first issue".
|
||||
|
||||
## All Netdata Users
|
||||
|
||||
|
|
@ -20,13 +20,17 @@ Specific GitHub issues we need help with can be seen [here](https://github.com/n
|
|||
|
||||
This is the minimum open-source users should contribute back to the projects they use. Github stars help the project gain visibility, stand out. So, if you use Netdata, consider pressing that button. **It really matters**.
|
||||
|
||||
### Join the Netdata Community
|
||||
|
||||
We have launched a [discussion board](https://community.netdata.cloud) where you can find many of us.
|
||||
|
||||
### Spread the word
|
||||
|
||||
Community growth allows the project to attract new talent willing to contribute. This talent is then developing new features and improves the project. These new features and improvements attract more users and so on. It is a loop. So, post about Netdata, present it to local meetups you attend, let your online social network or twitter, facebook, reddit, etc. know you are using it. **The more people involved, the faster the project evolves**.
|
||||
|
||||
### Provide feedback
|
||||
|
||||
Is there anything that bothers you about Netdata? Did you experience an issue while installing it or using it? Would you like to see it evolve to you need? Let us know. [Open a github issue](https://github.com/netdata/netdata/issues) to discuss it. Feedback is very important for open-source projects. We can't commit we will do everything, but your feedback influences our road-map significantly. **We rely on your feedback to make Netdata better**.
|
||||
Is there anything that bothers you about Netdata? Did you experience an issue while installing it or using it? Would you like to see it evolve to match your requirements? Let us know by making a post at [at Netdata Community](https://community.netdata.cloud/category/4/feedback) to discuss it or [open a GitHub issue](https://github.com/netdata/netdata/issues). Feedback is very important for open-source projects. We can't commit we will do everything, but your feedback influences [our roadmap](https://community.netdata.cloud/category/1/announcements-and-roadmap) significantly. **We rely on your feedback to make Netdata better**.
|
||||
|
||||
### Translate some documentation
|
||||
|
||||
|
|
@ -46,11 +50,11 @@ Netdata is all about simplicity and meaningful presentation. A "sponsor" for a c
|
|||
- 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
|
||||
#### Sponsor an exporting connector
|
||||
|
||||
We already support various [backends](backends) and we intend to support more. A "sponsor" for a backend:
|
||||
We already support various [exporting connectors](/exporting/README.md), and we intend to support more. A "sponsor" for a connector:
|
||||
|
||||
- Suggests ways in which the information in Netdata could best be exposed to the particular backend, to facilitate meaningful presentation.
|
||||
- Suggests ways in which the information in Netdata could best be exposed to the particular endpoint, 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).
|
||||
|
|
@ -59,7 +63,7 @@ We already support various [backends](backends) and we intend to support more. A
|
|||
|
||||
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).
|
||||
- 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).
|
||||
|
||||
|
|
@ -167,14 +171,14 @@ When you contribute code to Netdata, you are automatically accepting that you wi
|
|||
|
||||
The single most important rule when writing code is this: *check the surrounding code and try to imitate it*. [Reference](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en)
|
||||
|
||||
We use several different languages and have had contributions from several people with different styles. When in doubt, you can check similar existing code.
|
||||
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 occasionally 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() {`.
|
||||
- Allow max line length of 120 chars
|
||||
- Allow opening brace at the end of a function declaration: `function() {`.
|
||||
- Allow trailing comments
|
||||
|
||||
### Your first pull request
|
||||
|
|
@ -186,7 +190,7 @@ There are several guides for pull requests, such as the following:
|
|||
|
||||
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)
|
||||
|
||||
One thing you will need to do only for your first pull request in Netdata is to accept the CLA. Until you do, the automated check for the CLA acceptance will be showing as failed.
|
||||
One thing you will need to do only for your first pull request in Netdata is to accept the CLA. Until you do, the automated check for the CLA acceptance will be showing as failed.
|
||||
|
||||
#### PR Guidelines
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ Netdata is **distributed, real-time performance and health monitoring** for syst
|
|||
highly-optimized monitoring agent you install on all your systems and containers.
|
||||
|
||||
Netdata provides **unparalleled insights**, in **real-time**, of everything happening on the systems it's running on
|
||||
(including web servers, databases, applications), using **highly interactive web dashboards**.
|
||||
(including web servers, databases, applications), using **highly interactive web dashboards**.
|
||||
|
||||
A highly-efficient database **stores long-term historical metrics for days, weeks, or months**, all at 1-second
|
||||
granularity. Run this long-term storage autonomously, or integrate Netdata with your existing monitoring toolchains
|
||||
|
|
@ -336,7 +336,7 @@ This is what you should expect from Netdata:
|
|||
- **Unlimited metrics** - Netdata collects all the available metrics—the more, the better.
|
||||
- **1% CPU utilization of a single core** - It's unbelievably optimized.
|
||||
- **A few MB of RAM** - The highly-efficient database engine stores per-second metrics in RAM and then "spills"
|
||||
historical metrics to disk long-term storage.
|
||||
historical metrics to disk long-term storage.
|
||||
- **Minimal disk I/O** - While running, Netdata only writes historical metrics and reads `error` and `access` logs.
|
||||
- **Zero configuration** - Netdata auto-detects everything, and can collect up to 10,000 metrics per server out of the
|
||||
box.
|
||||
|
|
@ -437,7 +437,7 @@ by [**plugins**](/collectors/plugins.d/README.md), which support a variety of pr
|
|||
Python.
|
||||
|
||||
Popular collectors include **Nginx**, **Apache**, **MySQL**, **statsd**, **cgroups** (containers, Docker, Kubernetes,
|
||||
LXC, and more), **Traefik**, **web server `access.log` files**, and much more.
|
||||
LXC, and more), **Traefik**, **web server `access.log` files**, and much more.
|
||||
|
||||
See the **full list of [supported collectors](/collectors/COLLECTORS.md)**.
|
||||
|
||||
|
|
@ -469,6 +469,8 @@ You can also check all the other directories. Most of them have plenty of docume
|
|||
|
||||
## Community
|
||||
|
||||
We recently launched the [Netdata Community](https://community.netdata.cloud). You can find most of us there! It's also a good place to ask questions, find resources, or learn what features or fixes we are working on next.
|
||||
|
||||
We welcome [contributions](/CONTRIBUTING.md). Feel free to join the team!
|
||||
|
||||
To report bugs or get help, use [GitHub's issues](https://github.com/netdata/netdata/issues).
|
||||
|
|
|
|||
Loading…
Reference in New Issue