Readme #14
Readme #14
Conversation
|
I think we'd want something on integrations-core that points to this doc (whether here or on docs), then has some sort of messaging about how we make the split and more info/link to contact to start a dialog if it's something we really should have in core. I could go either way on leaving it here or moving to docs. Keeping it here means people have the info when they clone the repo. Moving it keeps all the docs centralized. |
|
I'm not sure where the best place to put it is. But I think it makes sense to at least link to it from here and from integrations-core, wherever it ends up. It looks good, though. |
|
@jyee looks like we require users have flake8 installed. Should we call that out somewhere here? |
| You will need a working [Ruby](https://www.ruby-lang.org) environment. For more information on installing Ruby, please reference [the Ruby installation documentation](https://www.ruby-lang.org/en/documentation/installation/). | ||
|
|
||
| You will also need [Wget](https://www.gnu.org/software/wget/). Wget is already installed on most Linux systems and is easy to install on Mac using [Homebrew](http://brew.sh/) or on Windows using [Chocolatey](https://chocolatey.org/). | ||
|
|
There was a problem hiding this comment.
flake8 will be required by the tests.
There was a problem hiding this comment.
flake8 should be automatically installed when running rake setup_env to build out the python environment. It's listed in the requirements-text.txt file that pip loads.
There was a problem hiding this comment.
need to add that you must use bash
There was a problem hiding this comment.
@technovangelist Can you explain more about the bash requirement or what you encountered?
| }) | ||
| ``` | ||
|
|
||
| For more information about writing checks and how to send metrics to the Datadog agent, reference our [Writing and Agent Check guide](http://docs.datadoghq.com/guides/agent_checks/) |
There was a problem hiding this comment.
should be "writing an agent check" not "and agent"
|
|
||
| We've written [a gem](https://rubygems.org/gems/datadog-sdk-testing) and a set of scripts to help you get set up, ease development, and provide testing. To begin: | ||
|
|
||
| 1. Clone the Github repository |
There was a problem hiding this comment.
the regular user wont be able to commit to this repo, so the first step should be to fork, then clone that repo
There was a problem hiding this comment.
they are just consumers of this repo, and generally wont be committing to it. It's probably fine to leave this as clone.
There was a problem hiding this comment.
so when they clone it, build their integration, where do they push the integration to? they need to push somewhere before they can do a pr.
|
|
||
| # Submitting Your integration | ||
|
|
||
| Once you have completed the development of your integration, submit a [pull request](https://github.com/DataDog/integrations-extras/compare) to have Datadog review your integration. Once we've reviewed your integration, we will approve and merge your pull request or provide feedback and next steps required for approval. |
There was a problem hiding this comment.
i think you should spell this out a bit more. this could be the first open source project they have contributed to. commit to their repo, then submit a pr to integrations-extra. we don't need to list every step but we should point to some instructions
|
|
||
| ## Building an integration | ||
|
|
||
| You can use rake to generate the skeleton for a new integration by running `rake generate:skeleton[my_integration]`, where "my_integration" is the name of your new integration. This will create a new directory, `my_integration`, that contains all the files required for your new integration. |
There was a problem hiding this comment.
need to explicitly call out that the [] are required.
|
See the corresponding PR in docs: DataDog/documentation#973 |
|
lgtm 👍 |
* add scope variable * fix description
* [ENT-2819] Robust Intelligence AI firewall integration initial commit (#1) * initial commit for check * check with correct metrics * add dashboard * update dashboard and readme * update dashboard title * fix readme links and add logos * fix support email link * update homepage and support email * [END-2821] Update README (#2) * update section on metrics collected * update firewall link and dashboard * [PINT-2462] readme fixes (#3) * readme fixes * update risk name * fix metrics section content * add image assets * [PINT-2485] PR build issues (#4) * lint fixes * add sales email * [PINT-2485] Address PR comments (#5) * update overview and description * add integrtaion version * add classifier tags * add dashboard description * add dashboard to manifest (#6) * [PINT-2541] readme review (#7) * add details to configure section * Add suggestion Co-authored-by: Arley Lewis <[email protected]> --------- Co-authored-by: Arley Lewis <[email protected]> * [PINT-2618] PR feedback and dashboard update (#8) * update readme and remove unnecessary file * upgrade dashboard * [PINT-2651] add dashboard banner image (#9) * add dashboard banner * update banner url * address PR comments (#10) * update description (#11) * [PINT-2719] readme and dashboard image (#12) * update dashboard image and description * update firewall image * update image ratio (#13) * [PINT-2891] add scope variable to dashboard (#14) * add scope variable * fix description * remove folder (#15) * fix import (#16) * run ddev validate ci * fix codecov * remove assets that are not required * add metrics check * add codeowners * fix format * remove non ascii character * fix test * add test --------- Co-authored-by: Arley Lewis <[email protected]>
First big draft of the integration docs. I still need to add more inline code samples and images, but this should provide enough info to help new contributors.