You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/01/06 18:16:00 UTC
[jira] [Commented] (METRON-1391) Typos in Documentation/Examples
within metron-management/README.md
[ https://issues.apache.org/jira/browse/METRON-1391?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16314792#comment-16314792 ]
ASF GitHub Bot commented on METRON-1391:
----------------------------------------
GitHub user 1havran opened a pull request:
https://github.com/apache/metron/pull/890
METRON-1391 Fix for README.md in Metron Management
## Contributor Comments
This PR fixes a README.md in metron-platform/metron-management.
1. Rules expression
SHELL_GET_EXPRESSION('is_local ') returns null since there is no expression
called 'is_local ' with trailing space. The expression called 'is_local'.
This fix removes the trailing space.
2. Triage rules
fix for missing score in rule1
## 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:
- [x] 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).
- [x] 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.
- [x] 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:
- [x] 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/1havran/metron fix_for_mgmt_readme
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/890.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 #890
----
commit e94b82a7fa06d6780190bb5e238416de799d4bec
Author: 1havran <ha...@...>
Date: 2018-01-06T17:57:35Z
Fix for README.md in Metron Management
1. rules
SHELL_GET_EXPRESSION('is_local ') returns null since there is no expression
called 'is_local ' with trailing space. The expression called 'is_local'.
This fix removes the trailing space.
2. triage rules
fix for missing score in rule1
----
> Typos in Documentation/Examples within metron-management/README.md
> ------------------------------------------------------------------
>
> Key: METRON-1391
> URL: https://issues.apache.org/jira/browse/METRON-1391
> Project: Metron
> Issue Type: Improvement
> Affects Versions: 0.4.2, 0.4.3
> Reporter: 1havran
> Priority: Trivial
>
> There are typos in the examples within metron-platform/metron-management/README.md.
> * SHELL_GET_EXPRESSION('is_local ') contains a trailing space. Such expression does not exist, since the expression should be 'is_local'.
> * Triage rule called rule1 does not contain a score.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)