METRON-1532: Getting started documentation improvements #1001
Conversation
|
+1 thees are useful additions for anyone getting started. |
| @@ -103,3 +103,8 @@ Tags are listed in the playbooks, some frequently used tags: | |||
| + `hdp-deploy` - Deploy and Start HDP Services (will start all Hadoop Services) | |||
| + `sensors` - Deploy and start the sensors. | |||
| + `sensor-stubs` - Deploy and start the sensor stubs. | |||
|
|
|||
|
|
|||
| ### Making Metron more stable for developers | |||
There was a problem hiding this comment.
@sardell Thanks for the contribution! This is good info. Rather than duplicating this between centos and ubuntu, could we put it here
- https://github.com/sardell/metron/tree/8034d69e9d3cb7f807881011f6ad50f145f89be8/metron-deployment#how-do-i-deploy-metron-on-a-single-vm
or here? - https://github.com/sardell/metron/blob/8034d69e9d3cb7f807881011f6ad50f145f89be8/metron-deployment/development/README.md
I'll leave it to your discretion.
There was a problem hiding this comment.
I would tend to agree with this and have this advice at the https://github.com/sardell/metron/blob/8034d69e9d3cb7f807881011f6ad50f145f89be8/metron-deployment/development/README.md level since the single node stuff people (probably misguidedly) use for purposes other than dev
There was a problem hiding this comment.
@simonellistonball @mmiklavc I'll go ahead and move this documentation to the metron-deployment/development level.
|
+1 Thanks @sardell |
Contributor Comments
I added the documentation items mentioned here: https://issues.apache.org/jira/browse/METRON-1532
Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
For all changes:
For code changes:
Have you included steps to reproduce the behavior or problem that is being changed or addressed?
Have you included steps or a guide to how the change may be verified and tested manually?
Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
Have you written or updated unit tests and or integration tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
For documentation related changes:
Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via
site-book/target/site/index.html:Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that travis-ci is set up for your personal repository such that your branches are built there before submitting a pull request.