Bug 1019610
Summary: | RFE - Add a 'pre-QA' report to the doc builder | ||
---|---|---|---|
Product: | [Community] PressGang CCMS | Reporter: | Tim Hildred <thildred> |
Component: | Web-UI | Assignee: | Nobody <nobody> |
Status: | NEW --- | QA Contact: | |
Severity: | unspecified | Docs Contact: | |
Priority: | unspecified | ||
Version: | 1.1 | CC: | cbredesen |
Target Milestone: | --- | ||
Target Release: | --- | ||
Hardware: | Unspecified | ||
OS: | Unspecified | ||
Whiteboard: | |||
Fixed In Version: | Doc Type: | Bug Fix | |
Doc Text: | Story Points: | --- | |
Clone Of: | Environment: | ||
Last Closed: | 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: | |||
Bug Depends On: | |||
Bug Blocks: | 1013887 |
Description
Tim Hildred
2013-10-16 07:11:58 UTC
Expansion of the workflow When you hit "Pre-QE Report" button, you get a series of check boxes, one for each test. At first, there is only on, "spellcheck". Then, as more tests get added, you'd get more checkboxes. That way, you would only run the tests you wanted reporting on. Eventually, you might even have a "custom test" button, that would allow people to run scripts against content (in a chrooted environment). Or something. Are there scripts that are currently run by QE? What I would like to work towards in a kind of "lint" type suite of standardised checks. Ideally these can be run in the browser as someone is editing a topic or content spec, and then also as a standalone application that can be run by groups like QE. I don't think they have anything as robust as is required. I'm looking at this as a 3 level edit. 1) Topic-level spelling and usage suggestions by computer 2) Book-level spelling and usage report by computer 3) Book-level process verification and sanity check by a person (docs QE) The problem with leaving it at a topic level check, is that a misspelled word gets highlighted, but can still be saved and published. Adding a book level, completely automated report gives that second layer of check when the high pressure moment of "write this topic now" has passed. A writer can (doc)build(er) their book, get the report, fix the book, re-(doc)build(er) their book, see that the report shows that the book contains zero typos, and then package it for QE. Spell checking is now performed across entire books. Doubled words are now detected across entire books. Style guide words and phrases are highlighted with different colored links: * Green means the word is valid, but may still have some additional information about its usage * Red means the word is invalid * Purple means the word may need to be changed as it is something that is potentially discouraged for use in technical documentation |