You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/09/19 21:52:20 UTC
[jira] [Commented] (METRON-433) Documentation update

    [ https://issues.apache.org/jira/browse/METRON-433?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15504794#comment-15504794 ] 

ASF GitHub Bot commented on METRON-433:
---------------------------------------

GitHub user cestella opened a pull request:

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

    METRON-433: Documentation update

    It has been a while since we had a holistic documentation review. I reviewed the README.md and
    * Rearranged content to better reflect the current segmentation of the model, moving a lot of content from metron-common
    * Added documentation and examples for MaaS
    * Added topology diagrams for the parser/enrichment topologies.
    * Added relevant examples of using stellar to do enrichments.
    * Made the stellar user defined functions provided up-to-date.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/cestella/incubator-metron documentation_catchup

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

    https://github.com/apache/incubator-metron/pull/260.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 #260
    
----
commit 6e2c7ba1fea2f00c3532c85ab123af0b6c18803a
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T19:25:45Z

    Updating readme

commit 4c9922bfcfe7c02e052ebb8880936a6d6886f25d
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T19:44:53Z

    Updating instructions.

commit a47b62e5f6a641beb6be671e64d2af2bbdde51af
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T19:45:40Z

    Updating instructions.

commit e7912f6da835b701772d9b15b7e6e86c5c55c114
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T19:59:28Z

    Updating instructions.

commit ef876f96c30ae95d0cff7a18d4247b94fede41bf
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T20:00:15Z

    Updating instructions.

commit bc6bcb4c59f0c2ddf9e0021d1be75ca0ea0c9c58
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T20:11:15Z

    Updating instructions.

commit 580ccf8eb76bdd1107fe92132d2a54f5c83789e5
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T20:33:55Z

    Updating instructions.

commit 6a839f1e2bba6e8d5e83776ac4818032d44bd1bc
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T20:51:30Z

    Updating instructions.

commit 9aa4ff40bc98f17cf99129645005c3e778652b3e
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T20:52:34Z

    Updating instructions.

commit 857a5f154714b92473cae3712675de5c0b8aee36
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:02:02Z

    Updating readme with example.

commit dbe7d8c1ffbb54960f894a00f1b777c019db8ee2
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:06:17Z

    Updating instructions.

commit 778ec95aa838cb99848ce2ff06d3a662beb0130e
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:08:39Z

    updating pic

commit 39695f81b7157739cfcbab30d95e4844aa6d104c
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:26:09Z

    Updating docs.

commit eecb724b1d50c8d4ad49e11f0716d9cfc2b23bfa
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:39:28Z

    Updating docs

commit b4e7ae72ca7ca16cbd70fdf1dd4cdfde486f860f
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:44:16Z

    Updating to refer to METRON_HOME

commit 7d37fe59e3e6ed154d4622425bc1843edde071ca
Author: cstella <ce...@gmail.com>
Date:   2016-09-19T21:50:01Z

    updated stellar functions.

----


> Documentation update
> --------------------
>
>                 Key: METRON-433
>                 URL: https://issues.apache.org/jira/browse/METRON-433
>             Project: Metron
>          Issue Type: Task
>            Reporter: Casey Stella
>            Assignee: Casey Stella
>             Fix For: 0.2.1BETA
>
>   Original Estimate: 24h
>  Remaining Estimate: 24h
>
> It has been a while since we had a holistic documentation review.  I reviewed the README.md and 
> * Rearranged content to better reflect the current segmentation of the model, moving a lot of content from metron-common
> * Added documentation and examples for MaaS
> * Added topology diagrams for the parser/enrichment topologies.
> * Added relevant examples of using stellar to do enrichments.
> * Made the stellar user defined functions provided up-to-date.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)