GitHub user DimDroll opened a pull request:
https://github.com/apache/metron/pull/789
METRON-1233: Remove description of Global configuration from Enrichment doc
It confuses reader. Description of Global configuration is available ahead
of the enrichment and listed here:
https://metron.apache.org/current-book/metron-platform/metron-common/index.html
Global config is used for validation of the fields.
Enrichment is used for fields enrichment and probably can also be used for
validation of the fields (which is not covered in the doc).
From available doc I can see that they serve two different purposes.
So, I don't see any reason to mention global config in enrichment
description. What's the benefit of knowing about global configuration when you
want deep dive in enrichment?
## Contributor Comments
[Please place any comments here. A description of the problem/enhancement,
how to reproduce the issue, your testing methodology, etc.]
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
for the complete guide to follow for contributions.
Please refer also to our [Build Verification
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
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:
- [ ] Is there a JIRA ticket associated with this PR? If not one needs to
be created at [Metron
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [ ] Does your PR title start with METRON-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [ ] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### 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:
```
mvn -q clean integration-test install && build_utils/verify_licenses.sh
```
- [ ] 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](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] 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`:
```
cd site-book
mvn site
```
#### 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](https://travis-ci.org) is set up
for your personal repository such that your branches are built there before
submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/DimDroll/incubator-metron patch-5
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/789.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #789
----
commit 3bc88e5fac42d164265db467b8c07a9f04807406
Author: DimDroll <dimdr...@gmail.com>
Date: 2017-10-05T14:57:10Z
Remove description of Global configuration
It confuses reader. Description of Global configuration is available ahead
of the enrichment and listed here:
https://metron.apache.org/current-book/metron-platform/metron-common/index.html
Global config is used for validation of the fields.
Enrichment is used for fields enrichment and probably can also be used for
validation of the fields (which is not covered in the doc).
From available doc I can see that they serve two different purposes.
So, I don't see any reason to mention global config in enrichment
description. What's the benefit of knowing about global configuration when you
want deep dive in enrichment?
----
---
