GitHub user mmiklavc opened a pull request:
https://github.com/apache/incubator-metron/pull/554
Metron 899: Fix bad Kerberos doc merge in METRON-835
Addresses https://issues.apache.org/jira/browse/METRON-899
The purpose of this PR is to address a bad merge that occurred with the
Kerberos manual and Ambari MPack docs. I'd like this to be looked over by more
than 1 other committer because of the complexity of the conflict resolution.
To verify, please review the changes I've made. Also be sure to run through
the site-book changes to make sure my fixes there work as intended. The images
weren't rendering before.
The steps I took in order to resolve this are as follows
1. Revert Kerberos-setup.md to jusinleet's version before METRON-835. Take
Nick's original branch changes (before the merge) from METRON-835 and replace
the manual instructions in metron-deployment.
1. Manually re-apply Nick's merge changes from METRON-835 to the manual
Kerberos instructions.
1. Manually re-apply Justin's changes post-move/copy to the manual Kerberos
instructions. Refactor the docs to keep common tasks in the manual doc rather
than the Ambari doc.
1. Move the Ambari Kerberos instructions from vagrant to metron-deployment
and rename as Ambari setup.
1. Fix the site-book to properly resolve the images - this was in part to
address my moving the readme for Ambari, but also a pre-existing condition.
Each of the above steps reflects a commit I made that should hopefully make
each transformation to the docs more clear. At first I thought I could do a
simple revert on the file and copy the changes to the new manual Kerberos doc,
but there was more to it than that. The reason this became as difficult as it
was to resolve is because it wasn't as simple as a basic content diff. There
were numerous factors involved:
- New content
- Modified formatting
- More new content with other PR's still in flux
- More new content with original content migrated to a new location and
also modified
- A PR (835) merged on top of a file that appeared at a glance to still be
the original + 835's changes, but was in fact was greatly modified by another
PR.
- At any given time, there were as many as 4 PR's modifying or moving this
doc
## Pull Request Checklist
### 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:
na
### 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
bin/generate-md.sh
mvn site: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/mmiklavc/incubator-metron METRON-899
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/554.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 #554
----
commit f9a2afa7dc337f9ec36d38484adceb755fbf7d62
Author: Michael Miklavcic <[email protected]>
Date: 2017-04-27T19:04:27Z
METRON-899: Revert Kerberos-setup.md to jusinleet's version before
METRON-835. Take Nick's original branch changes (before the merge) from
METRON-835 and replace the manual instructions in metron-deployment.
commit ced8f82df425dad9906b1d568734a26e78b1621f
Author: Michael Miklavcic <[email protected]>
Date: 2017-04-27T19:38:14Z
METRON-899: Re-apply Nick's merge changes from METRON-835 to the manual
Kerberos instructions.
commit 52cd35fdf54d373c5673319d90a3e36d79d3ce68
Author: Michael Miklavcic <[email protected]>
Date: 2017-04-27T21:08:29Z
METRON-899: Re-apply Justin's changes post-move/copy to the manual Kerberos
instructions. Refactor the docs to keep common tasks in the manual doc rather
than the Ambari doc.
commit 4937427cb15d69df461f71bbe8b23d21d27733eb
Author: Michael Miklavcic <[email protected]>
Date: 2017-04-27T21:16:30Z
METRON-899: Move the Ambari Kerberos instructions from vagrant to
metron-deployment and rename as Ambari setup.
commit 80a009f653a4624a51fe819aa2f3a1d07022e938
Author: Michael Miklavcic <[email protected]>
Date: 2017-04-27T22:06:33Z
METRON-899: Fix site-book generation for the Kerberos docs.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
