Skip to content

Commit ac41f34

Browse files
authored
Merge pull request #3710 from DataDog/massi/readme
Slim down the README and redirect to datadog-agent
2 parents 9501ade + c9d2d8e commit ac41f34

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

README.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,24 @@
11
[![Build Status](https://travis-ci.org/DataDog/dd-agent.svg?branch=master)](https://travis-ci.org/DataDog/dd-agent)
22

3-
The Datadog Agent faithfully collects events and metrics and brings
4-
them to [Datadog](https://app.datadoghq.com) on your behalf so that
5-
you can do something useful with your monitoring and performance data.
3+
# Important note
64

7-
You're looking at the source code right now. We provide a number of
8-
pre-packaged binaries for your convenience for both [Agent 5](https://app.datadoghq.com/account/settings?agent_version=5#agent) and [Agent 6]((https://app.datadoghq.com/account/settings#agent)).
5+
This repository contains the source code for the Datadog Agent up to and including
6+
major version 5.
7+
Although still supported, no major feature is planned for this release line and we
8+
encourage users and contributors to refer to the new Agent codebase, introduced
9+
with the release of version 6.0.0 and tracked in
10+
[a different git repository](https://github.com/DataDog/datadog-agent).
911

10-
See the [Datadog Agent Repo](https://github.com/DataDog/datadog-agent) for the source code for Agent 6.
12+
## Changes
1113

12-
Note: this repository does not contain the sources of the Trace Agent that
13-
collects traces for the APM feature. If you choose the installation from source
14-
or the Windows and Mac OS X builds you will need to install the Trace Agent
15-
separately. See
16-
[dd-trace-agent](https://github.com/DataDog/datadog-trace-agent) for
17-
instructions.
14+
Please refer to the [Change log](https://github.com/DataDog/dd-agent/blob/master/CHANGELOG.md)
15+
for more details about the changes introduced at each release.
1816

19-
# [Change log](https://github.com/DataDog/dd-agent/blob/master/CHANGELOG.md)
17+
## How to contribute code
2018

21-
# How to contribute code
22-
23-
First of all and most importantly, **thank you** for sharing.
24-
25-
If you want to submit code, please fork this repository and submit pull requests against the `master` branch.
26-
For more information, please read our [contributing guidelines](CONTRIBUTING.md).
19+
Before submitting any code, please read our [contributing guidelines](CONTRIBUTING.md).
20+
We'll keep accepting contributions as long as the major version 5 is supported
21+
but please consider submitting new features to the new Agent codebase.
2722

2823
Please note that the Agent is licensed for simplicity's sake
2924
under a simplified BSD license, as indicated in the `LICENSE` file.
@@ -32,15 +27,12 @@ If you do **not** agree with the licensing terms and wish to contribute code non
3227
please email us at <[email protected]> before submitting your
3328
pull request.
3429

35-
# [Integration SDK](https://github.com/DataDog/integrations-core)
36-
37-
All checks have been moved to the [Integration SDK](https://github.com/DataDog/integrations-core). Please look there to submit related issues, PRs, or review the latest changes.
38-
39-
## Setup your environment
30+
### Setup your environment
4031

4132
Required:
42-
- python 2.7
43-
- bundler (to get it: `gem install bundler`)
33+
34+
* python 2.7
35+
* bundler (to get it: `gem install bundler`)
4436

4537
```
4638
# Clone the repository
@@ -61,23 +53,28 @@ bundle exec rake lint
6153
bundle exec rake ci:run[apache]
6254
```
6355

64-
## Test suite
56+
## Integrations
57+
58+
All checks have been moved to the [Integrations Core](https://github.com/DataDog/integrations-core) repo.
59+
Please look there to submit related issues, PRs, or review the latest changes.
60+
61+
## Tests
6562

6663
More about how to write tests and run them [here](tests/README.md)
6764

68-
# How to configure the Agent
65+
## How to configure the Agent
6966

7067
If you are using packages on linux, the main configuration file lives
7168
in `/etc/dd-agent/datadog.conf`. Per-check configuration files are in
7269
`/etc/dd-agent/conf.d`. We provide an example in the same directory
7370
that you can use as a template.
7471

75-
# How to write your own checks
72+
## How to write your own checks
7673

7774
Writing your own checks is easy using our checks.d interface. Read more about
7875
how to use it on our [Guide to Agent Checks](http://docs.datadoghq.com/guides/agent_checks/).
7976

80-
# Contributors
77+
## Contributors
8178

8279
```bash
8380
git log --all | grep 'Author' | sort -u

0 commit comments

Comments
 (0)