Bug 811740

Summary: Release notes: Section 3.1.5 missing a "." at end of "etc"
Product: Red Hat Satellite Reporter: Corey Welton <cwelton>
Component: DocumentationAssignee: Lana Brindley <lbrindle>
Status: CLOSED WORKSFORME QA Contact: Katello QA List <katello-qa-list>
Severity: low Docs Contact:
Priority: low    
Version: 6.0.0CC: cpelland, mhideo
Target Milestone: UnspecifiedKeywords: Documentation
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-04-11 21:01:39 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Corey Welton 2012-04-11 20:41:25 UTC
The aforementioned section reads:


3.1.5. Using 'abrt' Lucene query syntax elasticsearch returns error

One deviation that we have from Lucene syntax is that the behavior of the '-' operator is being disabled. In Lucene, this boolean operator is used to exclude documents that contain the term after the -. Since '-' is commonly used in CFSE as a separator in names (e.g. repository, package...etc), it has been agreed to disable it within CFSE. This basically means to 'escape' it, treating it as a normal character.

It should read:
3.1.5. Using 'abrt' Lucene query syntax elasticsearch returns error

One deviation that we have from Lucene syntax is that the behavior of the '-' operator is being disabled. In Lucene, this boolean operator is used to exclude documents that contain the term after the -. Since '-' is commonly used in CFSE as a separator in names (e.g. repository, package...etc.), it has been agreed to disable it within CFSE. This basically means to 'escape' it, treating it as a normal character.



That said, I'm not sure "etc." seems very documentation-friendly, either, but I'm not a docs writer, so I don't know.

Comment 1 Lana Brindley 2012-04-11 21:01:39 UTC
Thanks Corey. This has already been revised in the working copy, and the updated version will be pushed live with the next round.

LKB