Re: what to do about typoes in online docs?
by Karsten Wade
Note: bouncing this to f-docs-l for larger audience and comments.
On Thu, 2005-06-16 at 13:21 -0400, Robert P. J. Day wrote:
> is anyone interested in minor typoes in the online docs? and i mean
> "minor" in the sense that, yes, they should be fixed but, no, i'm not
> about to go thru bugzilla to report them. life's way too short for
> that.
Thanks for noticing and caring. :)
Reporting of typos via email is more likely to get dropped or forgotten
than if they are in a bug. Because of the amount of bugs, changes, and
feature requests that can come in for a document, we use bugzilla as a
tracking tool with some workflow processes.
To alleviate the pain a bit, here are a few ideas:
* Many docs use a prefilled bugzilla report. You click on the link,
fill out two fields and submit. Much less pain. If a document does not
have such a link, it should.
* Gather a number of typos and include them in a single report,
minimizing time spent in bugzilla. Use a prefilled template, where
possible.
* Get CVS access and fix them yourself.
I think the point is this: if you find typos in a document, you are
likely to group them together into one email already. You won't send a
separate email for every typo, right? Once you've gone that far, it
only takes a few extra, short steps to make a bug report.
Because we can have bugzilla do dependency tracking, properly reported
bugs cannot fall through the cracks.
thx - Karsten
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
toolchain - what's happening?
by Karsten Wade
Can I get some information/status on these items? These are some starts
and stops we've made over the last few months, and I'm working on
bringing them all together into an alpha toolchain.
* Patching of xmlto to use Saxon
Did Gavin and Tommy work on this?
* Compiling of Saxon and fop using gcj
Did Tommy get anywhere on this?
I don't know if we can use a Java-based toolchain, but we won't know
unless we make one and try it out. :)
- Karsten
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
update Mysql-3.23 to 4.1
by Pragati Sinha
hi,
i have installed SNORT on my FC3 machine alongwith
nessus .I am now getting this Security warning that i
should upgrade Mysql from older version 3.23 that i
have at present, to 4.1
i downloaded its rpm n followed these steps,but got
this error.cant find a solution how to upgrade this.
# rpm -Uvh MySQL-server-4.1.12-1.i386.rpm
warning: MySQL-server-4.1.12-1.i386.rpm: V3 DSA
signature: NOKEY, key ID 5072e1f5
error: Failed dependencies:
libmysqlclient.so.10 is needed by (installed)
perl-DBD-MySQL-2.9003-5.i386
libmysqlclient.so.10 is needed by (installed)
mod_auth_mysql-20030510-5.i386
libmysqlclient.so.10 is needed by (installed)
php-mysql-4.3.11-2.5.i386
libmysqlclient.so.10 is needed by (installed)
MyODBC-2.50.39-19.1.i386
can someone plese help me with this...
thanks,
Pragati
_______________________________________________________
Too much spam in your inbox? Yahoo! Mail gives you the best spam protection for FREE! http://in.mail.yahoo.com
18 years, 10 months
[ANN] Creation of the "docs-common" subdirectory tree
by Tommy Reynolds
Ahoy, Doc'ers!
Earlier on this list, Paul Frields began a discussion about moving
all the overhead directories ("common", "css", "stylesheet-images",
and "xsl") into a single object. That way, the root directory of
everyone's working tree would not be cluttered with boilerplate
cruft.
The ensuing discussion has led to the creation of the "docs-common"
top-level directory. This now holds the four older directories
mentioned above. The old "doc-setup" object is no more.
The "docs-common" is intended to be a peer directory for the
individual document directories. To check out a document for local
editing or building, two steps are needed:
$ cvs checkout docs-common
$ cvs checkout the-doc-I-want
Note that checking out "docs-common" is a one-time operation; all
documents will share that one instance.
At least two changes need be made to each document's "Makefile":
1) Change the relative paths for the "XSLPDF" and "XSLHTML" macros
from "../xsl" to "../docs-common/xsl".
2) Change the relative path of the "cp ../stylesheet-images" line to
"cp ../docs-common/stylesheet-images"
Then, in the parent file of each document, change the relative paths
of the "FEDORA-ENTITIES-EN" entity from "../common" to
"../docs-common/common". Yeah, I know, it looks redundant, doesn't
it? Also change the relative path of the "LEGALNOTICE" entity from
"../common" to "../docs-common/common".
With these changes, you document should build.
Now, go back to your top-level directory, the one that now holds
"docs-common" and *stale* copies of "common", "css",
"stylesheet-images", and "xsl" directories. Take a deep breath and
type:
$ rm -rf README common css stylesheet-images xsl
to get rid of the files that are now part of "docs-common".
If you have any questions about this process, look at the
"example-tutorial/" document: it has the necesssary changes.
Cheers
18 years, 10 months
FDSCo minutes for 14 June 2005
by Karsten Wade
I decided to just send these here, as being more of specific interest to
us and not general interest to f-announce-l.
Fedora Documentation Steering Committee (FDSCo)
14 June 2005 20:00 UTC every Tuesday
#fedora-docs on irc.freenode.net
Attendees:
==========
Tommy Reynolds
Stuart Elliss
Gavin Henry
Karsten Wade (gavel)
Updates:
========
Stuart - X > Gstreamer is not ready for a student bounty, vnc2swf
requires new packaging work, probably not the bounty for us
to use. Still looking for new ideas.
New Actions:
============
Karsten - Note on wiki about symlinking inside a module to the
docs-common - for DOCG ideas page
Karsten - Define common staging environment, run by list.
Karsten - Decommission the Package List doc.
Tommy - Work with Elliot to get stuff moved in CVS, updates to
example-tutorial, announcement to f-docs-l
Paul - evaluation of xmlformat in progress
## 30 ##
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
utf-8 encoding when building
by Karsten Wade
This is a status update about some encoding issues we have had building
and serving Fedora Core documents.
This came to a head recently because the release notes I built were
utf-8 encoded but fedora.redhat.com was not specifying that in the
<meta> tag, so the pages were being served as ISO-8859-1 (Apache
default, iirc) and had funny characters.
Today we adjusted the page templates to use UTF-8, which removes all the
ugly characters for those docs, and introduces a few character problems
in docs built using other character sets.
Examples of the latter are the Stateless Linux Tutorial and the Apache
SELinux doc. The problem there is not as visually acute, and I can
rebuild them with a UTF-8 envar and see if that fixes stuff.
I'm not sure what we are going to do about all this, but my feeling is
that we should *start* from wherever the Fedora Core default is. If
that is UTF-8, that's what we should be using as a baseline.
- Karsten
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
HCL Considered Harmfull [Re: Fedora HCL guide writers?]
by Tommy Reynolds
On Thu, 2 Jun 2005 10:50:49 -0700 Chidananda Jayakeerti
<ajchida(a)gmail.com> wrote:
> Hello,
Nice to meet you. Sorry to be so late responding to your posting,
but I've been away from the office for a week. And I lost your
original email. And my dog ate my homework. Just kidding.
Anyway, I'll make an attempt at answering your question; other
members will probably have different ideas than mine. That is OK,
I'm just thinking out loud here.
> I have been resorting to "googling" for Fedora HCL due to the lack of
> such a guide. I have a crude list of hardware list built from
> experience. This is in no means a official HCL and has very few
> hardware.
I understand your interest in having a Fedora HCL, so that when you
configure a system you have at least _some_ hope that the result will be
functional. However, looking at some of the public comments about
past experiences with HCL's are revealing.
I do not think that having an HCL will be a good idea for Fedora. Red
Hat was able to publish their HCL because one of their business services
was to certify that a certain combination of vendor hardware and
software worked when RH tested it. They were paid handsomely for this
service. Vendors liked the idea, but the next engineering change to
either the hardware or the software rendered that particular
certification worthless because the entry was actually a tuple:
Certification[N] = [Hardware(Model,ECO,Options), Software
(Version,patch]]
Because of the cost involved, many vendors never re-certified for new
versions.
The HCL also contained some anecdotal entries, of the "this worked for
me" variety.
The end result was the HCL rapidly became stale. Translation: big
maintenance chore. Also, it was never intended to be
authoritative, but that's the way it was used. If someone wanted to
install Linux, they would check the HCL and then panic because their
particular combination was not listed.
In the end, the HCL has languished and gotten only sporadic attention.
Fedora now includes an Installation Guide and Release Notes that
describe the minimal hardware configuration, in generic terms.
Google.com is probably the best solution to this issue; especially given
the short development cycle of the Fedora project.
> However, looking at https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129784
> I realise i might as well start off an official one. Are there any
> writiers understaking such a task?
> How do I go about starting one? I could do the SelfIntroduction stuff
> (although i'm not too comfortable reveling my residence address to a
> mailing list :).
We would welcome your contribution to the Docs project. A
self-introduction is, rather firmly, the most minimal of membership
requirements. We won't come to your house to check your address, but
notice the section that asks "Why should we trust you?".
I think an address of at least the city? country? continent? world?
solar system? galaxy? 'verse? is intended to give folks some idea of
whom you are. Wade, is this right?
Cheers!
18 years, 10 months