From fffdd2eab06166ff499cbc1967b19eae661e7d21 Mon Sep 17 00:00:00 2001 From: Meir Wahnon Date: Mon, 1 Aug 2016 19:28:29 +0300 Subject: [PATCH 1/3] Fixing some comments Fixing some comments --- README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9e8b8b3effd3..19c0eb05b93e 100644 --- a/README.md +++ b/README.md @@ -20,15 +20,7 @@ The scripts are built to run inside the Demisto Platform - they can query or sen 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 adding/modifing playbooks/scripts please read our contributer guide [here](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 +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 From 268bdb37cdcbb5744c27ac10ff9457b3aa32c4ea Mon Sep 17 00:00:00 2001 From: liorkol Date: Mon, 1 Aug 2016 12:55:26 -0400 Subject: [PATCH 2/3] Phrasing, links. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 19c0eb05b93e..6df5bdf7cc8d 100644 --- a/README.md +++ b/README.md @@ -13,14 +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. ## Contributing Content -For adding/modifing playbooks/scripts please read our contributer guide [here](https://github.com/demisto/content/blob/master/CONTRIBUTING.md) +For nstructions about adding/modifying playbooks and scripts please see our [contributor guide](https://github.com/demisto/content/blob/master/CONTRIBUTING.md). -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 +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) From b25d7b31af05f07b2709c42b45eea283a44ece75 Mon Sep 17 00:00:00 2001 From: liorkol Date: Mon, 1 Aug 2016 13:17:11 -0400 Subject: [PATCH 3/3] Phrasing, structure of instructions --- CONTRIBUTING.md | 14 +++++++------- README.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef3096dedc3a..8d4e1cdfaa4d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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) diff --git a/README.md b/README.md index 6df5bdf7cc8d..05048acda4cf 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,6 @@ You can take your logic and the way you want to work and write your own scripts, 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. ## Contributing Content -For nstructions about adding/modifying playbooks and scripts please see our [contributor guide](https://github.com/demisto/content/blob/master/CONTRIBUTING.md). +For instructions about adding/modifying playbooks and scripts please see our [contributor guide](https://github.com/demisto/content/blob/master/CONTRIBUTING.md). 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)