Skip to content

Commit

Permalink
Merge pull request #3 from demisto/comments-README
Browse files Browse the repository at this point in the history
Fixing some comments
  • Loading branch information
liorkol authored Aug 1, 2016
2 parents 115510a + b25d7b3 commit 96777aa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 21 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Contributing Playbooks

Our playbooks are described in an open format which we released called [COPS](https://github.com/demisto/COPS) to drive collaboration and interoperability within the InfoSec community.
Our playbooks are described in an open format we released called [COPS](https://github.com/demisto/COPS) to drive collaboration and interoperability within the InfoSec community.

In order to add playbooks you need to save them in the open playbook format(yaml file) and create a Pull Request.
In order to contribute playbooks you need to save them in the COPS format (as a yaml file) and create a Pull Request.

You can also edit them visually inside the Demisto Platform and export to a yaml file.
You can also edit them visually inside the Demisto Platform and then export to a yaml file.

Also you can create a PR to modify an existing playbook.
To add a new playbook, or modify and enhance an existing playbook - just open a Pull Request in this repo.

## Contributing Scripts

In addition to the actual scripts in a Py or JS file, you need to add a small section in the scripts.json file, with the script's display name, description, arguments and other metadata.
In addition to the actual scripts in a Py or JS file, you need to add a small section in the scripts.json file, with the script's display name, description, arguments and other metadata.
Here is a description of scripts.json fields and structure:

``` json
Expand Down Expand Up @@ -43,5 +43,5 @@ Here is a description of scripts.json fields and structure:
},
```

Enjoy and feel free to reach out to us on the DFIRCommunity Slack, or at using this repo issues.

If you have a suggestion or an opportunity for improvement that you've identified, please open an issue in this repo.
Enjoy and feel free to reach out to us on the [DFIR Community Slack channel](https://www.demisto.com/community/), or at [info@demisto.com](mailto:info@demisto.com)
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,14 @@ We will be releasing more and more playbooks for interesting scenarios, so stay

The spec for our new format can be found here: https://github.com/demisto/dfir-playbook-spec

## scripts
These scripts written in Python or Javascript perform Security Operations tasks.
The scripts are built to run inside the Demisto Platform - they can query or send commands to a long list of existing security products, and react based on the output.
## Scripts
These scripts written in Python or Javascript perform Security Operations tasks.
The scripts are built to run inside the Demisto Platform - they can query or send commands to a long list of existing security products, and react based on the output.

You can take your logic and the way you want to work and write your own scripts, allowing for maximum flexibility.
The services and products you use can be online Cloud-based or on-premises setups, and we have tools to support more complex topologies such as when the product's subnet is firewalled off.

# Adding content
## Adding Playbooks
Our playbooks are described in an open format which we are releasing to drive collaboration and interoperability within the InfoSec community. We realize every organization has different needs and we wanted to create something that allows for that flexibility.
## Contributing Content
For instructions about adding/modifying playbooks and scripts please see our [contributor guide](https://github.com/demisto/content/blob/master/CONTRIBUTING.md).

In order to add playbooks you need to save them in the open playbook format and send a Pull Request. You can also edit them visually inside the Demisto Platform and export to a file.

## Adding Scripts
In addition to the actual scripts in a py or js file, you need to add a small section in the `scripts.json` file, with the script's display name, description, arguments and other metadata.
Here is a description of `scripts.json` fields and structure:


Enjoy and feel free to reach out to us on the DFIRCommunity Slack, or at <email-here>
Enjoy and feel free to reach out to us on the [DFIR Community Slack channel](https://www.demisto.com/community/), or at [info@demisto.com](mailto:info@demisto.com)

0 comments on commit 96777aa

Please sign in to comment.