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

ASF GitHub Bot commented on NIFI-5469:
--------------------------------------

Github user andrewmlim commented on a diff in the pull request:

    https://github.com/apache/nifi/pull/2922#discussion_r205890860
  
    --- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
    @@ -3074,69 +3178,69 @@ 
nifi.provenance.repository.encryption.key=0123456789ABCDEFFEDCBA9876543210012345
     The Component Status Repository contains the information for the Component 
Status History tool in the User Interface. These
     properties govern how that tool works.
     
    -The buffer.size and snapshot.frequency work together to determine the 
amount of historical data to retain. As an example to
    +The `buffer.size` and `snapshot.frequency` work together to determine the 
amount of historical data to retain. As an example to
     configure two days worth of historical data with a data point snapshot 
occurring every 5 minutes you would configure
     snapshot.frequency to be "5 mins" and the buffer.size to be "576". To 
further explain this example for every 60 minutes there
     are 12 (60 / 5) snapshot windows for that time period. To keep that data 
for 48 hours (12 * 48) you end up with a buffer size
     of 576.
     
     |====
     |*Property*|*Description*
    -|nifi.components.status.repository.implementation|The Component Status 
Repository implementation. The default value is 
`org.apache.nifi.controller.status.history.VolatileComponentStatusRepository` 
and should not be changed.
    -|nifi.components.status.repository.buffer.size|Specifies the buffer size 
for the Component Status Repository. The default value is `1440`.
    -|nifi.components.status.snapshot.frequency|This value indicates how often 
to present a snapshot of the components' status history. The default value is 
`1 min`.
    +|`nifi.components.status.repository.implementation`|The Component Status 
Repository implementation. The default value is 
`org.apache.nifi.controller.status.history.VolatileComponentStatusRepository` 
and should not be changed.
    +|`nifi.components.status.repository.buffer.size`|Specifies the buffer size 
for the Component Status Repository. The default value is `1440`.
    +|`nifi.components.status.snapshot.frequency`|This value indicates how 
often to present a snapshot of the components' status history. The default 
value is `1 min`.
     |====
     
     
     [[site_to_site_properties]]
     === Site to Site Properties
     
     These properties govern how this instance of NiFi communicates with remote 
instances of NiFi when Remote Process Groups are configured in the dataflow.
    -Remote Process Groups can choose transport protocol from RAW and HTTP. 
Properties named with _nifi.remote.input.socket.*_ are RAW transport protocol 
specific. Similarly, _nifi.remote.input.http.*_ are HTTP transport protocol 
specific properties.
    +Remote Process Groups can choose transport protocol from RAW and HTTP. 
Properties named with `nifi.remote.input.socket.`* are RAW transport protocol 
specific. Similarly, `nifi.remote.input.http.`* are HTTP transport protocol 
specific properties.
    --- End diff --
    
    Will make these changes.  There are other trailing asterisks as noted in 
the comments below that should NOT be formatted as they are meant to designate 
properties that require upgrade considerations.


> Edits needed for LDAP and Kerberos login identity provider sections in Admin 
> Guide
> ----------------------------------------------------------------------------------
>
>                 Key: NIFI-5469
>                 URL: https://issues.apache.org/jira/browse/NIFI-5469
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>            Reporter: Andrew Lim
>            Assignee: Andrew Lim
>            Priority: Minor
>
> Going through the Authentication and Authorization sections of the Admin 
> Guide, I noticed the following improvements could be made:
>  * Removed “Kerberos Config File” property from kerberos-provider login 
> identity provider (this was done because the same property exists in 
> nifi.properties)
>  * Corrected the "LDAP-based Users/Groups Referencing User Attribute” login 
> identity provider example to refer to “member uid"
>  * Added titles to login identity provider examples for improved 
> readability/search
>  * Changed UserGroupProvider property examples from bulleted lists to tables
> Also, text formatting for references to config files, directories, etc.  need 
> to be made consistent.  For example, config files like _nifi.properties_, 
> _authorizers.xml_ should be italicized.  Directories, properties and default 
> values for properties should be monospaced.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to