[docs] Add Authors, Contributors, and additional doc changes #28

jacknagz · 2017-02-08T19:33:32Z

to @airbnb/streamalert-maintainers

size: med

Add CONTRIBUTING.rst and AUTHORS.rst
Add jinja2 to requirements.txt
Additional documentation on quick start, writing rules, and more

ghost · 2017-02-08T20:01:59Z

CONTRIBUTING.rst

+
+StreamAlert contains unit tests for many parts of the code.  When making changes, you need to ensure that you do  not break existing functionality.  To run unit tests locally::
+
+  $ nosetests -v test/unit


denote the directory this should be run from

ghost · 2017-02-08T20:02:30Z

CONTRIBUTING.rst

+
+Each test should end with ``... ok``, and finally you should see ``OK`` at the end.
+
+If you are making changes which require test refactoring, please do so.


unit test refactoring

ghost · 2017-02-08T20:03:18Z

CONTRIBUTING.rst

+
+If you are making changes which require test refactoring, please do so.
+
+If you are adding features to existing classes with tests, you must add test cases to verify your changes.


to verify your changes do what you expect them to

ghost · 2017-02-08T20:03:40Z

CONTRIBUTING.rst

+Integration Testing
+~~~~~~~~~~~~~~~~~~~
+
+To verify StreamAlert end to end locally, follow the testing instructions `here <https://streamalert.io/rules.html>`_. 


To verify StreamAlert works from end-to-end, locally, follow ...

ghost · 2017-02-08T20:04:03Z

CONTRIBUTING.rst

+Pull Request
+------------
+
+Once your branch is ready, push it to your forked repository, and make a pull-request to the main ``airbnb/streamalert`` repo.


Once your code is ready for review, push ...

ghost · 2017-02-08T20:07:04Z

docs/source/conf-datasources.rst


 Overview
 --------

-Datasources are defined in ``conf/sources.json``
+* Datasources defined in ``conf/sources.json`` control which datasources can send to and be analyzed by StreamAlert.
+* Each datasource (``kinesis``, ``s3``) contains a mapping of specific entity names (kinesis streams, s3 buckets) along with a list of logs coming from that source.


"contains a mapping of specific entity names (kinesis streams, s3 buckets)" - this may be confusing for folks, what's an "entity" or "entity name"

ghost · 2017-02-08T20:08:18Z

docs/source/getting-started.rst


-1. Define your `account <account.html>`_
+1. Create your `AWS account <account.html>`_


Define vs. Create (define implies you can use existing or create a new one)

ghost · 2017-02-08T20:09:57Z

docs/source/rules.rst


 matchers
 ~~~~~~~~

-``matchers`` defines the conditions that need to be satisfied in order for the ``def`` function block to run against an incoming record.
+``matchers`` define the additional conditions that must be satisfied for an alert to be triggered.  This serves two purposes:


they are conditions that must be satisfied before a rule even executes

ghost · 2017-02-08T20:11:00Z

docs/source/rules.rst


-Matchers can serve 2 purposes:
+Matchers are generally defined in ``rules/matchers.py``, but they can also in rule files if the following line is added::


Matchers are defined in ``rules/matchers.py`. If desired, matchers can also be defined in Rule files if the following line is added to the top of the Rule files

ghost · 2017-02-08T20:11:55Z

docs/source/rules.rst


-Within each of these folders you can define:
+In order to test the effectiveness of our new rules, we can run a set of local integration tests to verify alerts would be triggered.  The `stream_alert_cli.py` command line tool comes built-in with a `lambda test` command.


you switched from 'you' to 'we', I suggest switching back

austinbyers · 2017-02-08T21:48:58Z

🎉 Yay for documentation! 📜 🎉

[docs] update docs with additional deployment and setup details [docs] add streamalert authors [docs] add contributing guide [docs] feedback from #28 [docs] add streamalert logo [docs] README updates

jacknagz force-pushed the docs-conf-authors-contribs-reqs branch from c635933 to c3dbbe9 Compare February 8, 2017 19:34

ghost suggested changes Feb 8, 2017

View reviewed changes

jacknagz pushed a commit that referenced this pull request Feb 8, 2017

[docs] feedback from #28

585b7ae

jacknagz force-pushed the docs-conf-authors-contribs-reqs branch from 585b7ae to 93454c8 Compare February 8, 2017 21:15

jacknagz pushed a commit that referenced this pull request Feb 8, 2017

[docs] feedback from #28

93454c8

ghost approved these changes Feb 8, 2017

View reviewed changes

jacknagz force-pushed the docs-conf-authors-contribs-reqs branch 4 times, most recently from eeebd60 to de7dfec Compare February 8, 2017 21:41

jacknagz force-pushed the docs-conf-authors-contribs-reqs branch from de7dfec to 077d9eb Compare February 8, 2017 21:49

[docs][setup] doc updates and add jinja2 to requirements.txt

40489d5

[docs] update docs with additional deployment and setup details [docs] add streamalert authors [docs] add contributing guide [docs] feedback from #28 [docs] add streamalert logo [docs] README updates

jacknagz force-pushed the docs-conf-authors-contribs-reqs branch from 077d9eb to 40489d5 Compare February 8, 2017 21:50

jacknagz merged commit c60e8cf into master Feb 8, 2017

jacknagz deleted the docs-conf-authors-contribs-reqs branch February 8, 2017 22:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Add Authors, Contributors, and additional doc changes #28

[docs] Add Authors, Contributors, and additional doc changes #28

jacknagz commented Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

ghost Feb 8, 2017

austinbyers commented Feb 8, 2017


		StreamAlert contains unit tests for many parts of the code. When making changes, you need to ensure that you do not break existing functionality. To run unit tests locally::

		$ nosetests -v test/unit


		Each test should end with ``... ok``, and finally you should see ``OK`` at the end.

		If you are making changes which require test refactoring, please do so.


		If you are making changes which require test refactoring, please do so.

		If you are adding features to existing classes with tests, you must add test cases to verify your changes.


		1. Define your `account <account.html>`_
		1. Create your `AWS account <account.html>`_


		Matchers can serve 2 purposes:
		Matchers are generally defined in ``rules/matchers.py``, but they can also in rule files if the following line is added::


		Within each of these folders you can define:
		In order to test the effectiveness of our new rules, we can run a set of local integration tests to verify alerts would be triggered. The `stream_alert_cli.py` command line tool comes built-in with a `lambda test` command.

[docs] Add Authors, Contributors, and additional doc changes #28

[docs] Add Authors, Contributors, and additional doc changes #28

Conversation

jacknagz commented Feb 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

austinbyers commented Feb 8, 2017