Bug 129986 - include system documenting guidelines in the Doc Guide
include system documenting guidelines in the Doc Guide
Product: Fedora Documentation
Classification: Fedora
Component: documentation-guide (Show other bugs)
All Linux
medium Severity medium
: ---
: ---
Assigned To: Douglas Silas
Tammy Fox
: FutureFeature
Depends On:
Blocks: fedora-docs-ideas fdp-docguide-traqr
  Show dependency treegraph
Reported: 2004-08-16 08:26 EDT by Karsten Wade
Modified: 2009-07-30 20:50 EDT (History)
1 user (show)

See Also:
Fixed In Version:
Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2009-07-30 20:50:26 EDT
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Karsten Wade 2004-08-16 08:26:38 EDT
In addition to detailing how to do screenshots, we need to specify 
how to eliminate variables that are not common to a Fedora Core
installation.  For example, using a default, fresh user account
prevents customizations in the author's ~/.bash* files such as
additions to te $PATH.  

This "System Documenting Guidelines" would include best practices for
technology usage, such as using rpm packages instead of tarballs.  We
might choose to have equal preferences for equivalent technologies,
such as up2date and yum.

A big reminder to include is to document the existing system, not
provide "fixes" that make a system unsupportable, abnormal, or
otherwise _more_ difficult to maintain.

This would be a chapter or section.
Comment 1 Douglas Silas 2009-07-27 18:29:07 EDT
This bug is ancient, and no longer seems applicable to me. In particular, because this has been assigned to me, it would need to apply to the Fedora Deployment Guide, which seems to cover what's listed here:


Any comments? If not, I will close this bug soon.
Comment 2 Douglas Silas 2009-07-30 20:50:26 EDT
Because using rpms instead of tarballs, etc. is well-represented in the RPM Guide, and will be also in the upcoming Fedora Deployment Guide (and probably elsewhere too), I am closing this as NOTABUG. If there are further requests along this line, please create a new bug for them. Thanks.

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