You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by mattf-horton <gi...@git.apache.org> on 2017/01/30 00:03:23 UTC
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
GitHub user mattf-horton opened a pull request:
https://github.com/apache/incubator-metron/pull/429
METRON-660 [Umbrella] up-to-date versioned documentation
This has come out rather well, I think. The integration is still open to discussion. Currently it is in a stand-alone, versioned-with-the-code sub-directory and sub-project. The idea is that a release manager would build the site-book (following the instructions below), then copy it into a versioned subdirectory of the (unversioned) public site, to publish it along with each code release.
To build the book, do the following:
In any git clone of incubator-metron containing the site-book subdirectory,
```
cd site-book
bin/generate-md.sh
mvn site:site
```
It only takes a few seconds. You may now view your copy of the book in a browser by opening `file:///your/path/to/incubator-metron/site-book/target/site/index.html`. On a Mac, you can just say `open target/site/index.html`
Enjoy! For code review purposes, the key files under site-book/ are:
* **bin/generate-md.sh** copies all .md files from the code directory tree into the site tree, performs some transformations on them, and generates the nav tree structure and labels.
* **bin/fix-md-dialect.awk** is called by 'generate-md.sh'. It does transforms within the text of each file, related to converting the Github-MD dialect of markdown into the doxia-markdown dialect.
* **pom.xml** and **src/site/site.xml** are doxia boilerplate, tweaked for our specific needs. Thanks to @mmiklavc for his help getting these right. Please don't squash the entire PR, as the second commit is to his credit.
* The rest is either routine fixes to .md file syntax, or should be self-explanatory.
No .md files were harmed in the making of this PR! The goal was "If it works in Github-MD, don't edit the source .md file -- fix it in the re-writer."
The only thing hardwired is the handling of the few image files used; that can be removed when it becomes important. Some may object to the awk script; if you wish to translate it into python, I'll be more than happy to accept the PR :-)
Thanks,
--Matt
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/mattf-horton/incubator-metron METRON-660
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/429.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 #429
----
commit 287609d0713d6938aa5bc191687b37fe402fe392
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-01-17T01:18:57Z
METRON-660 Prototype structure for .md assembly into book with maven doxia-markdown plugin.
commit 6d0fd35526162c7b4ef0e5cbc580266ecbb0ac96
Author: Michael Miklavcic <mi...@gmail.com>
Date: 2017-01-17T05:32:54Z
Fixes to get doxia markdown gen working
commit 678e7c277eea7b9257334829feaa2de96c63c5cf
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-01-19T08:19:00Z
METRON-660 Working generator script and site specification.
commit 05caea22cc896f773e3175aeca7c6aac2bd38de8
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-01-25T08:06:42Z
METRON-660 re-write rules for indenting, to conform Github-MD to doxia-markdown. First draft. Also misc fixes to markdown files.
commit 1c45318986b251faa3654f66368787ad6773df89
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-01-28T01:15:16Z
METRON-660 re-write rules for indenting, second generation.
commit 96755cb710a7187fd2c34f6700a0dd2a7893fcd2
Author: mattf-horton <mf...@hortonworks.com>
Date: 2017-01-29T23:26:16Z
METRON-660 re-write rules for links, third generation.
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@JonZeolla you pushed my perfectionist button :-) This latest push fixes the problem with anchors on H1 headers. The generated html is unchanged except for the insertion of anchor lines next to H1 header lines. The visuals appear the same.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98444660
--- Diff: site-book/src/site/site.xml ---
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project name="Falcon" xmlns="http://maven.apache.org/DECORATION/1.3.0"
--- End diff --
Could you change the name from 'Falcon'?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by james-sirota <gi...@git.apache.org>.
Github user james-sirota commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98728815
--- Diff: site-book/bin/generate-md.sh ---
@@ -190,7 +190,13 @@ cd site-book/src/site/markdown
# Rewrite hrefs for resource references, using table provided by Maintainers
for (( i=0; i<${#HREF_REWRITE_LIST[@]} ; i+=2 )) ; do
echo rewriting href in "${HREF_REWRITE_LIST[$i]}" : "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}"
- sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ if [[ "$OSTYPE" =~ "darwin" ]] ; then
+ # Macs need an argument after -i option
+ sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ else
--- End diff --
Is the path of least resistance here just to provide a docker container with the right version of awk?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
+1, this is great.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98521687
--- Diff: site-book/src/site/site.xml ---
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project name="Falcon" xmlns="http://maven.apache.org/DECORATION/1.3.0"
--- End diff --
Oops! Missed that one. Thanks for pointing it out.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98674950
--- Diff: site-book/bin/generate-md.sh ---
@@ -190,7 +190,13 @@ cd site-book/src/site/markdown
# Rewrite hrefs for resource references, using table provided by Maintainers
for (( i=0; i<${#HREF_REWRITE_LIST[@]} ; i+=2 )) ; do
echo rewriting href in "${HREF_REWRITE_LIST[$i]}" : "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}"
- sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ if [[ "$OSTYPE" =~ "darwin" ]] ; then
+ # Macs need an argument after -i option
+ sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ else
--- End diff --
I would suggest handling this slightly more explicitly. My two thoughts are:
1. Approach it similar to [here](https://github.com/anandsubbu/incubator-metron/blob/dc3fa9739bad53da7931d992cdfd499abba5387d/metron-deployment/scripts/platform-info.sh#L68), using a `case "${OSTYPE}"` to watch `darwin*` and `linux*`, and then a `*)` that alerts the user.
1. By adding an elif for either `"${OSTYPE}" == linux*` or `"${OSTYPE}" =~ "linux"`, and then an `else` that alerts the user.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@justinleet thanks for the catch. Fixed.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Great job with the migration to python, things look much much better now.
I did notice that the `h1` named anchors don't exist on `incubator-metron/site-book/target/site/metron-platform/metron-common/index.html` (Stellar_Language, Global_Configuration, Management_Utility) but these appear to be working in the [source README.md](https://github.com/apache/incubator-metron/tree/master/metron-platform/metron-common/). Other than that, everything looks good to me.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@justinleet , No, the advanced awk features are heavily used. Well, I guess this is a good reason to convert to a python script after all. I'll give it whack.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@mattf-horton
Obvious awk issue in output (that doesn't show up with gawk), that I should have noted, but apparently just shut my brain off for:
`
Fixing up markdown dialect problems between Github-MD and doxia-markdown:
./index.md
awk: syntax error at source line 147 in function fix_prefix_blanks source file /Users/jleet/Documents/workspace/incubator-metron/site-book/bin/fix-md-dialect.awk
context is
prefix_blanks = match($0, >>> /^[[:blank:]]*/, <<< a);
awk: illegal statement at source line 148 in function fix_prefix_blanks source file /Users/jleet/Documents/workspace/incubator-metron/site-book/bin/fix-md-dialect.awk
awk: illegal statement at source line 148 in function fix_prefix_blanks source file /Users/jleet/Documents/workspace/incubator-metron/site-book/bin/fix-md-dialect.awk
./metron-analytics/index.md
`
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@JonZeolla , interesting. That would be equivalent to gawk version 3.1.5 or 3.1.6. I see now that my updated awk is from a homebrew installation.
Would you be willing to update awk? If you already use homebrew, all you have to say is `brew install gawk`
If you don't yet use homebrew, that's a single-line install too.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
BTW, the instructions for use are unchanged, since the fix-up script is invoked from within the bin/generate-md.sh script.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@mattf-horton, thanks for taking the time/effort to migrate the script. Tried it out and it works great.
The only thing I'd like to see is the indentation in the Python script made consistent. I think spaces is more standard Python and swapping potentially creates issues because of the way Python handles tabs (searching around online suggests it's treated as 8 spaces).
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
Re: [GitHub] incubator-metron issue #429: METRON-660 [Umbrella]
up-to-date versioned docu...
Posted by "Zeolla@GMail.com" <ze...@gmail.com>.
Agreed, sounds good to me. I'm good with it getting merged.
Jon
On Fri, Feb 3, 2017, 6:31 PM mattf-horton <gi...@git.apache.org> wrote:
> Github user mattf-horton commented on the issue:
>
> https://github.com/apache/incubator-metron/pull/429
>
> Hi @JonZeolla , you have good eyes! I missed those cases, which are
> only visible where H1 headers have been used in the *body* of the document,
> AND there are TOC or other internal links to those headings.
>
> Eeesh, that's an unfortunate deficiency in the doxia-markdown plugin.
> Apparently it does not generate named anchors for the H1 headers, perhaps
> under the assumption there will only be one at the beginning of the doc?
> At any rate, I've opened two new jiras:
> - METRON-697 [site-book] doxia-markdown plugin doesn't generate named
> anchors for H1 headings
> METRON-698 [site-book] Add link checker as a "unit test" for site-book
> build
>
> But I request that we allow these to be addressed as follow-on tasks,
> so we can get the site-book as it is into the public's hands. Thanks.
>
>
> ---
> 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 infrastructure@apache.org or file a JIRA ticket
> with INFRA.
> ---
>
--
Jon
Sent from my mobile device
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Hi @JonZeolla , you have good eyes! I missed those cases, which are only visible where H1 headers have been used in the *body* of the document, AND there are TOC or other internal links to those headings.
Eeesh, that's an unfortunate deficiency in the doxia-markdown plugin. Apparently it does not generate named anchors for the H1 headers, perhaps under the assumption there will only be one at the beginning of the doc? At any rate, I've opened two new jiras:
- METRON-697 [site-book] doxia-markdown plugin doesn't generate named anchors for H1 headings
METRON-698 [site-book] Add link checker as a "unit test" for site-book build
But I request that we allow these to be addressed as follow-on tasks, so we can get the site-book as it is into the public's hands. Thanks.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
This is a fantastic improvement to what we have, and even though I'm just starting to dig in, this looks really good. I'll add any comments I have as I go through it, but this is great.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@mattf-horton Homebrew gawk seems to work out well for me. Not sure what the implementation difference is between the two though.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@justinleet , yah, that's typical of what I called "paragraph munching". The triple-backtick delimiter is being consumed as text, then interpreted as an empty double-backtick, followed by single backtick that starts a code-phrase, hence the ugly highlighting.
Was this with the homebrew awk? And can you confirm that
```
ls -l `which awk`
```
points at ../Cellar/gawk/4.1.1/bin/awk ?
It's most likely an awk problem, because that's where the re-writing gets done.
The only other toolchain, afaik, is maven, the maven-site-plugin, and doxia-module-markdown.
I'm using maven 3.3.9 on Mac OS X 10.11.6. The latter two are specified in the pom.xml file at version 3.4 and 1.6, respectively.
Could you confirm your maven version, and what versions of doxia and site are at
* ~/.m2/repository/org/apache/maven/plugins/maven-site-plugin/
* ~/.m2/repository/org/apache/maven/doxia/doxia-module-markdown/
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Ok, I'm going to hold off on any additional review until the move to a python script.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@justinleet and @JonZeolla , the issues you are describing with bullets and codeblocks sound like things I worked hard to fix, and they work on my system. Please see new screenshot at https://issues.apache.org/jira/secure/attachment/12850028/METRON-660-screenshot2.png
I'm running the re-writer under Mac OS X with GNU Awk version 4.1.1. Would you both please tell me what system you're running and what `awk --version` gives you? Thanks.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Okay, @JonZeolla , @justinleet , and others, the awk script has been replaced by a python script. The results of the dialect fix-up are identical to the awk script's results across all 37 .md files. Thanks.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Awesome stuff, I'm taking a look now.
Related to @justinleet's comment, it looks like the main `index.html` page has issues with nesting ordered and unordered lists. It looks like it's incorrectly ending the `<ol>` after "Efficient information storage" and starting a separate one before "An interface that gives a security..." where it should be a continuance of the first `<ol>`. Still looking at things...
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98531347
--- Diff: site-book/src/site/site.xml ---
@@ -0,0 +1,124 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project name="Falcon" xmlns="http://maven.apache.org/DECORATION/1.3.0"
--- End diff --
Done.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/429#discussion_r98739265
--- Diff: site-book/bin/generate-md.sh ---
@@ -190,7 +190,13 @@ cd site-book/src/site/markdown
# Rewrite hrefs for resource references, using table provided by Maintainers
for (( i=0; i<${#HREF_REWRITE_LIST[@]} ; i+=2 )) ; do
echo rewriting href in "${HREF_REWRITE_LIST[$i]}" : "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}"
- sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ if [[ "$OSTYPE" =~ "darwin" ]] ; then
+ # Macs need an argument after -i option
+ sed -i '' -e "${HREF_REWRITE_LIST[ $(( i + 1 )) ]}" "${HREF_REWRITE_LIST[$i]}"
+ else
--- End diff --
@JonZeolla thanks for the example pointer. Fixed.
@james-sirota , yes maybe sorta. But that's work too, and the on-going nuisance for people trying to use it isn't adequately balanced for the effort. I'm almost done with the conversion to python.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@mattf-horton I think we're dealing with different implementations of awk, rather than just a pure versioning issue. I'm guessing it works on that VM, because that version number looks like a Gawk number. I'm pretty sure it's not working on the default Mac, because it's a different implementation entirely.
At that point, we're saying that whoever is building has to install gawk if they're on Mac (which a good portion of people are). Could the awk script can be relatively easily refactored to not use gawk specifics functions/features? I simply don't have enough awk knowledge to know how easy/hard that would be
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/429
+1 looks good to me @mattf-horton.
Reviewed the latest commit and ran it up/did some brief validation.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Mac 10.12.2, awk version 20070501
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@justinleet , hi, sorry our responses crossed. Looks like the old awk is rejecting the regex, probably the `[:blank:]` notation? So yah, need an updated awk. Is that an acceptable solution?
On my Centos7 test VM, awk --version gives 4.0.2. Probably will work, but I'll try it out.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Guys, to make it easier to distinguish between tool problems vs content bugs, I've uploaded a tarball of the full site-book as built on my platform, at [site-book_0.3.0_20170130.tar.gz](https://issues.apache.org/jira/secure/attachment/12850032/site-book_0.3.0_20170130.tar.gz)
Could you please compare problems you are seeing in your build of the book, vs what you see in my build? Thanks.
BTW, I'm not minimizing the tool problems, they need to be resolved. But we do need to know whether we are looking at a tool problem or a content bug! :-)
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Thank you all for your efforts reviewing this.
@cestella , I have rebased to master and re-validated. The only conflict was a trivial edit in one doc file.
Per discussions in the mailing lists, I also squashed most of my commits to a single one, leaving the necessary to preserve the attribution of @mmiklavc 's assist. Hence a total of three commits.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@mattf-horton
Screenshots from your build vs mine of code formatting. I assume both are off the latest, because the title name is correct on both (not included in the pics). Both are in Chrome.
Yours (which looks good):
<img width="1085" alt="mattf_book" src="https://cloud.githubusercontent.com/assets/5077341/22440115/35999044-e700-11e6-9406-b75ac3692f64.png">
Mine (which does not look good):
<img width="1069" alt="leet_book" src="https://cloud.githubusercontent.com/assets/5077341/22440117/388b46da-e700-11e6-8f82-63634366ae4d.png">
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #429: METRON-660 [Umbrella] up-to-date version...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-metron/pull/429
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/429
I'm +1 as well, merge master in @mattf-horton and I'll commit. Great work; I've been lurking on this one and like what I saw. :1st_place_medal:
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:
https://github.com/apache/incubator-metron/pull/429
Bullet points get a little weird in some places. (e.g. in the metron-maas-service README). Looks like, if we don't have a newline before the first bullet, it looks like it just includes it as part of the previous sentence. I found a few in the metron-maas-service README, but it wouldn't surprise me if more show up.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #429: METRON-660 [Umbrella] up-to-date versioned docu...
Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:
https://github.com/apache/incubator-metron/pull/429
@cestella , as Release Manager you can choose whether to accept this last commit (if @JonZeolla has time to review it) or just roll in the previous change set. I'm ok either way.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---