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

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

Github user mattf-horton commented on a diff in the pull request:

    https://github.com/apache/metron/pull/656#discussion_r129220852
  
    --- Diff: metron-analytics/metron-profiler/README.md ---
    @@ -83,9 +83,9 @@ At this point the Profiler is running and consuming 
telemetry messages.  We have
     
     ## Getting Started
     
    -This section will describe the steps required to get your first "Hello, 
World!"" profile running.  This assumes that you have successfully [installed 
the Profiler](#installation) and have it running.
    +This section will describe the steps required to get your first "Hello, 
World!"" profile running.  This assumes that you have a successful Profiler 
[installation](#installation) and have it running.
    --- End diff --
    
    The anchor text in square brackets must be capitalized to match the header 
text being referenced: \[Installation\].  As is it will cause a broken link in 
Doxia.


> Improve Docs of `profiler.period.duration` 
> -------------------------------------------
>
>                 Key: METRON-1050
>                 URL: https://issues.apache.org/jira/browse/METRON-1050
>             Project: Metron
>          Issue Type: Bug
>    Affects Versions: 0.4.0
>            Reporter: Nick Allen
>            Assignee: Nick Allen
>             Fix For: 0.4.1
>
>
> It is a common mistake for new user's of the Profiler, to alter the 
> Profiler's `profiler.period.duration` property, but not alter the 
> corresponding `profiler.client.period.duration` property.  The new user is 
> then unable to read the profile data as they would expect.
> More should be done, but this JIRA focuses on improving the documentation 
> around this common error experienced by new users.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to