[
https://issues.apache.org/jira/browse/METRON-1532?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16447797#comment-16447797
]
ASF GitHub Bot commented on METRON-1532:
----------------------------------------
GitHub user sardell opened a pull request:
https://github.com/apache/metron/pull/1001
METRON-1532: Getting started documentation improvements
## 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](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 &&
dev-utilities/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/sardell/metron METRON-1532
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1001.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 #1001
----
commit 1a712a53d0c9a93db2ebfce7c0e44bfd765755de
Author: Shane Ardell <sardell@...>
Date: 2018-04-21T15:54:32Z
add credentials to getting started documentation
commit 8034d69e9d3cb7f807881011f6ad50f145f89be8
Author: Shane Ardell <sardell@...>
Date: 2018-04-23T08:52:05Z
add instructions to make full dev more stable
----
> Getting started documentation improvements
> ------------------------------------------
>
> Key: METRON-1532
> URL: https://issues.apache.org/jira/browse/METRON-1532
> Project: Metron
> Issue Type: Improvement
> Reporter: Shane Ardell
> Priority: Trivial
> Original Estimate: 0.5h
> Remaining Estimate: 0.5h
>
> After running through a fresh install of full dev on my local machine, I
> think the documentation could improve by including some essential credential
> information in the full dev README. The credentials exist elsewhere in the
> Metron documentation, but for someone spinning up full dev for the first
> time, it's important to have credentials for apps like the Metron UI and
> Ambari easy to find.
> I also think it's worth documenting how to make full dev more stable on your
> machine by turning off various services via Ambari.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
