Bug 901704 - Replace "Fedora" with "&PRODUCT;"
Summary: Replace "Fedora" with "&PRODUCT;"
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora Documentation
Classification: Retired
Component: security-guide
Version: devel
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: Eric Christensen
QA Contact: Fedora Docs QA
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-01-18 20:43 UTC by eric
Modified: 2013-05-06 18:43 UTC (History)
5 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2013-05-06 18:43:59 UTC
Embargoed:


Attachments (Terms of Use)
Patch to remove all "Fedora" (110.10 KB, patch)
2013-01-18 20:43 UTC, eric
no flags Details | Diff
Replaced "Feodra" with "&PRODUCT" (110.10 KB, patch)
2013-01-18 21:11 UTC, eric
no flags Details | Diff
Patch to replace *some* of the 'Fedora's with &PRODUCT; (97.39 KB, patch)
2013-01-25 15:45 UTC, Eric Christensen
no flags Details | Diff

Description eric 2013-01-18 20:43:55 UTC
Created attachment 682699 [details]
Patch to remove all "Fedora"

Description of problem: The Security Guide has a sprinkling of "Fedora" through the guide.  We want to try to make sure that the guides are easily changeable to other products through the entity file.

Version-Release number of selected component (if applicable): 18.0.1

Comment 1 eric 2013-01-18 21:11:59 UTC
Created attachment 682723 [details]
Replaced "Feodra" with "&PRODUCT"

Comment 2 Ben Cotton 2013-01-23 22:06:00 UTC
QA failed.

- Publican entities are referenced with &ENTITY; so it should be "&PRODUCT;"

- Not all replacements make sense. In some cases keeping "Fedora" hard-coded is more correct:
   - Author_Group.xml, Lines 42 and 51 (author affiliations will not change if this guide is reused for another product)
   - Basic_Hardening.xml, Line 32 (the '16's only make sense in a Fedora context), Line 41 (the '9' only makes sense in a Fedora context)
   - Book_Info.xml, Lines 7,10,13 (I think Publican has problems with entities in the *_Info.xml files. It makes sense to leave 'Fedora' in this file anyway, since any reuse will necessarily involve editing this file)
   - Encryption.xml, Line 21 (the '9' only makes sense in a Fedora context)
   - Exploits.xml, Line 35 (the '12' only makes sense in a Fedora context)
   - Firewall.xml, Line 621 (the '12' only makes sense in a Fedora context)
   - LUKSDiskEncryption.xml, Lines 13,61 (the '9' only makes sense in a Fedora context)
   - Nmap.xml, Line 11 (the '10' only makes sense in a Fedora context)
   - Revision_History.xml - revert all references back to 'Fedora'
   - SSO_Overview.xml, Line 67 (the '5.2' only makes sense in a Fedora context)
   - Secure_Installation.xml, Line 28 (the '9' only makes sense in a Fedora context)



Unrelated observation:
Kerberos.xml, Line 331: the &lt; and &gt; saround 'version-number' should be removed. DocBook's <replaceable> tag pair will properly format the file name.

Comment 3 Eric Christensen 2013-01-25 15:45:34 UTC
Created attachment 687521 [details]
Patch to replace *some* of the 'Fedora's with &PRODUCT;

Comment 4 Ben Cotton 2013-01-25 19:18:41 UTC
There are two missing ; on line 32 of Security_Updates.xml. Add those and you can consider QA passed!

Comment 5 Eric Christensen 2013-05-06 18:43:59 UTC
This has been fixed.


Note You need to log in before you can comment on or make changes to this bug.