Skip to content

Commit 110a974

Browse files
masciGus
authored and
Gus
committed
Update the readme with the latest info (DataDog#2280)
* update the readme with the latest info * better paragraph title
1 parent 691290c commit 110a974

File tree

1 file changed

+8
-29
lines changed

1 file changed

+8
-29
lines changed

README.md

+8-29
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,10 @@ This repository contains the Agent Integrations (also known as checks) that Data
99
officially develops and supports. To add a new integration, please see the [Integrations Extras][5]
1010
repository and the [accompanying documentation][6].
1111

12-
The [Datadog Agent][7] packages are equipped
13-
with all the checks from this repository, so to get started using them, you can
14-
simply [install the Agent][8] for your operating
15-
system.
16-
17-
General documentation about the project can be [found here](docs/README.md)
12+
The [Datadog Agent][7] packages are equipped with all the Integrations from this
13+
repository, so to get started using them, you can simply [install the Agent][8]
14+
for your operating system. The [AGENT_CHANGELOG](AGENT_CHANGELOG.md) file shows
15+
which Integrations have been updated in each Agent version.
1816

1917
## Integrations as Python wheels
2018

@@ -29,35 +27,17 @@ where everything falls into place in the new approach.
2927
| `{integration}/test_check.py` | `{integration}/tests/*.py` |
3028
| n/a | `{integration}/setup.py` |
3129

32-
## A note about installing
33-
3430
Now that integrations are cleanly defined as python packages, we will soon be able
3531
to ship them as Python wheels that will be pip-installable in the Python environment
3632
embedded into the Datadog Agent. This presents a paradigm change in the way we will
3733
be delivering standalone integration upgrades, moving away from OS-specific packages
3834
to idiomatic Python package delivery.
3935

40-
Agent releases starting from version 5.21 bundle the latest wheels for any
41-
integration, but at the moment you can't upgrade or downgrade between releases.
42-
43-
Each Datadog Agent release will continue to ship a set of the most up to date stable integrations available. The `requirements-agent-release.txt` file at the root of this repo is the best place to check what Integration version is shipped with each Agent.
44-
45-
**Note** The release process is currently in flux as we move toward the ability to ship wheels independently of Agent releases. Due to this, the Changelog may show a version and release that isn't yet available to download. Please check the below table to see which Integration versions are shipped with your Agent install.
36+
## Contributing
4637

47-
| Agent Version | List of Shipped Integration Versions |
48-
| --------------- | -------------------------------------- |
49-
| 6.2.1 | [Link][15] |
50-
| 6.3.0 | [Link][16] |
51-
52-
## Quick Start
53-
54-
Working with integrations is easy, the main page of the [development docs](docs/dev/README.md)
38+
Working with integrations is easy, the main page of the [development docs][6]
5539
contains all the info you need to get your dev enviroment up and running in minutes
56-
to run, test and build a Check.
57-
58-
**Important:** the instructions are only valid for a subset of the Checks in this
59-
repository. Making all the checks work with the new build and test strategy is
60-
a work in progress. You can find the list of the checks already updated [here][14]
40+
to run, test and build a Check. More advanced API documentation can be found [here][20]
6141

6242
## Reporting Issues
6343

@@ -70,15 +50,14 @@ and [knowledge base][12]. You can also visit our
7050
[3]: https://ci.appveyor.com/api/projects/status/8w4s2bilp48n43gw?svg=true
7151
[4]: https://ci.appveyor.com/project/Datadog/integrations-core
7252
[5]: https://github.com/DataDog/integrations-extras
73-
[6]: https://docs.datadoghq.com/developers/integrations/integration_sdk/
53+
[6]: https://docs.datadoghq.com/developers/integrations
7454
[7]: https://github.com/DataDog/datadog-agent
7555
[8]: https://docs.datadoghq.com/agent/
7656
[9]: https://docs.pytest.org/en/latest/
7757
[10]: https://packaging.python.org/tutorials/distributing-packages/
7858
[11]: https://docs.datadoghq.com
7959
[12]: https://help.datadoghq.com/hc/en-us
8060
[13]: https://docs.datadoghq.com/help/
81-
[14]: https://github.com/DataDog/integrations-core/blob/master/tasks/constants.py#L15
8261
[15]: https://github.com/DataDog/integrations-core/blob/6.2.1/requirements-integration-core.txt
8362
[16]: https://github.com/DataDog/integrations-core/blob/ea2dfbf1e8859333af4c8db50553eb72a3b466f9/requirements-agent-release.txt
8463
[17]: https://codecov.io/github/DataDog/integrations-core/coverage.svg?branch=master

0 commit comments

Comments
 (0)