Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-1275: Fix Metron Documentation #833

Closed
wants to merge 6 commits into from

Conversation

JonZeolla
Copy link
Member

Contributor Comments

Documentation fixes, pretty straightforward. Most notably documents all of the start_parser_topology.sh params.

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:

  • Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
  • 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 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 is set up for your personal repository such that your branches are built there before submitting a pull request.

@lvets
Copy link

lvets commented Nov 7, 2017

I don't know whether my +1 is actually relevant, but here it goes: +1. Looks good to me :)

@nickwallen
Copy link
Contributor

Yes @lvets your +1 is definitely relevant. I wish more community members would review PRs.

-sp 24 \
-snt 24 \
-k $BROKERLIST \
-ksp SASL_PLAINTEXT \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will only work in a Kerberized environment, no? Should that be called out?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, sorry that's already how the docs were. I wasn't following what you were doing here. All you're doing is a reformat. LGTM.

@nickwallen
Copy link
Contributor

@JonZeolla I am assuming you just added additional options that are now available. That being the case, +1 from me.

@cestella
Copy link
Member

cestella commented Nov 7, 2017

Piling on with a +1, great job @JonZeolla

@asfgit asfgit closed this in c225fc4 Nov 8, 2017
iraghumitra pushed a commit to iraghumitra/incubator-metron that referenced this pull request Nov 20, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants