tpalfy commented on a change in pull request #4123: NIFI-7188: Adding filter 
capabilities into search & prerequisite refactors
URL: https://github.com/apache/nifi/pull/4123#discussion_r400921543
 
 

 ##########
 File path: nifi-docs/src/main/asciidoc/user-guide.adoc
 ##########
 @@ -167,6 +167,74 @@ contains options that allow you to manipulate existing 
components on the canvas:
 
 image::global-menu.png[NiFi Global Menu]
 
+=== Keywords in searching
+
+NiFi UI's search functionality supports a number of "keywords". These are 
literals used to execute search based on non-textual information. A keyword is 
used only in case of the search term consists of a section of the keyword or 
matches with it. In case the keyword is only the subset of the search term, the 
keyword is not picked for usage. The keywords are case-insensitive. The 
supported keywords are the following:
 
 Review comment:
   I think these document sections should be worded as simply as possible.
   `literal` for example in the sense it is used here is a computer science 
specific expression and meant to be used for fixed values in the _source code_.
   In general it should read naturally for basically any user, here's a 
suggestion:
   ```
   Users can use pre-defined (case-insensitive) keywords in the search box that 
will check certain conditions (instead of trying to match labels and values 
etc.).
   Keywords can be used with filters (see below) but not with other search 
terms (otherwise they won't be treated as keywords) and only one keyword can be 
used at a time.
   Note however that keywords will also be treated as general search terms at 
the same time.
   The supported keywords are the following:
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to