metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From JonZeolla <...@git.apache.org>
Subject [GitHub] incubator-metron pull request #512: METRON-824 site-book generation is broke...
Date Wed, 05 Apr 2017 01:22:47 GMT
GitHub user JonZeolla opened a pull request:

    https://github.com/apache/incubator-metron/pull/512

    METRON-824 site-book generation is broken

    ## Contributor Comments
    Currently, if you attempt to build the site-book on master you get the following error:
    ```
    ERROR OR ERRORS DETECTED:
    ERROR: Header specification character (#) detected with indenting.  This is presumed to
be an error, since it will render as text. If intentional, put a period or other printable
character before it.
    on line: 16 in file: ./metron-sensors/bro-plugin-kafka/index.md
        # curl -L https://github.com/edenhill/librdkafka/archive/v0.9.4.tar.gz | tar xvz
    ```
    
    In order to fix this I changed `metron-sensors/bro-plugin-kafka/index.md` to use triple
backticks instead of indentation to indicate the code block.  This allows it to parse properly
in GitHub MD as well as our Doxia site-book docs.
    
    
    ## Pull Request Checklist
    
    Thank you for submitting a contribution to Apache Metron (Incubating).  
    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 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/JonZeolla/incubator-metron METRON-824

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-metron/pull/512.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 #512
    
----
commit 5379d8c4f44f0bb10760a13cdef4618bd83803b7
Author: Jon Zeolla <zeolla@gmail.com>
Date:   2017-04-05T01:10:45Z

    Use backticks instead of indentation for codeblocks

----


---
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.
---

Mime
View raw message