Here are some further ideas about the role of an editor:
* Helps writing adhere throughout the creation process to the
(unwritten) Style Guide(lines).
* The relationship between authors and editors will take many forms.
Some people will create a pairing, two or more people who work together
regularly on a set of docs.
* Two people can edit each other's document. This is often a good way
to get a technical edit.
* Before going live, a document needs two editorial sign-offs -- writing
style (grammar, spelling, etc.) and technical content.
* Should there be an editorial board? Such a board would oversee the
Fedora docs, make sure we are adhering to our standards, filling in
holes, following or advancing our process, etc.
* Separate mailing list for editors? Or just accept that
fedora-docs-list gets busier with traffic between editors and authors.
The more I think about it, the more I think we should keep all traffic
on the one mailing list until there is a solid reason split. For
example, the editorial board needs to do its deliberations and decisions
in the open, and it's unfair to make people go to a separate mailing
list just to see that. We'll get better community input if we do
editorial stuff on the main list.
* Also, much of the editing traffic can be in bugzilla, as each document
will have it's own bug throughout it's lifecycle.
* The board can be in charge of deciding between competing or
conflicting documents. Still, we can agree that more choice is better,
so having documents that cover multiple methods of solving the same
problems just means we get to bundle them together as a set. :)
* The board needs to have an odd number of people so that if consensus
can't be reached, a majority vote without a tie is possible.
* The board members don't necessarily have to edit anything actively.
* Editorial board could just form like Voltron right now from available
interested parties (myself included there, please), and proceed with
some process defining.
Karsten Wade, RHCE, Tech Writer
a lemon is just a melon in disguise
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Since no one else started it, the tracker now is:
I've added various docs that should be on the site, so to speak.
Comments, etc.. welcome (on the bug)
Paul, I notice several docs at docs.frields.org, if they're ready, or
awaiting QA/editors, you should submit them to bugzilla
Colin Charles, byte(a)aeon.com.my
"First they ignore you, then they laugh at you, then they fight you,
then you win." -- Mohandas Gandhi
The Mailing list sure has been active the last few days. I think it took
almost an hour to get thru the digests.
I have propagated the following URL for Fedora Documents:: www.FedoraDocs.com
I have place a mission statement and an overview of what I hope to
accomplish with this site.
I am hoping to provide a release point for a large number of Fedora
Documents. This may, or may not, be a new paradigm ~ But I was trying to
visualize howto release a large # of docs, but not bog my server down with
traffic for indiv. files.
If you have any documentation that you wish to submit, please send it via
email to :: deposit(a)fedoradocs.com.
I will use it to create the first batch release. I am still working out,
fielding suggestions, on whether to tarball, RPM or other such release
Also, I don't want to infringe on the GNU, FDL licensure, but I need to
annotate the files in some way to allow verisoning and details about the
file to be noted in a TOC or some such thing. Any clarification on howto
preserve this would be helpful.
Ideas, submissions are requested and encouraged.
> On Mon, 2004-08-16 at 13:44, redwire(a)therockmere.com wrote:
>> The Mailing list sure has been active the last few days. I think it took
>> almost an hour to get thru the digests.
>> I have propagated the following URL for Fedora Documents::
> Is that a domain you've bought Brad, or a part of RH?
> Regards DaveP.
> XSLT&Docbook FAQ
I have purchased the site myself. I am not associated with Red Hat on a
I was looking for a name that would be discriptive.
I'm hoping someone here has a quick solution. I'm working on a document
and my tags are giving me a problem under psgml. At a certain point in
my document, when I use a <filename> tag, slashes in the file name
content (not inside the tag marker) are being interpreted as ending tags
for the content outside "filename." So when I type:
the first slash is being seen as </para>, and the second as </sect1>.
(Yes, I know, I haven't converted this to <section> usage yet.)
I've looked through the document and used C-C C-C to check context all
the way up to the tag in question, and can't seem to find any funkiness.
I even used TAB to see if the indentation would show me where there was
a problem. Nothing seems to be wrong until I type that tag.
When I save and "make html," for example, the code validates properly.
Does anyone have any suggestions? Please be gentle, and remember that I
am a DocBook, XML, and Emacs idiot. I've learned enough to write and
markup, but am not familiar with the internals of any of these tools.
Paul W. Frields, RHCE
I dutifully put a 'bug' report on the fedora bugzilla thingy,
but also wanted to announce that (over time) I'll be collating
a list of links all related to Fedora based software.
I probably will add a documentation section, since Mark was the
first in there, but my primary aim is to link to alternatives
until we have our own suite of documentation.
E.g. If I can figure out how, whilst plowing through that
buzilla form, I came across a pull-down menu which seemed
to list the applications/tools in Fedora?
Be nice to have such a list with links to the home pages,
LDP pages etc.
All contributions of the format:
Link: two line comment about 'why I think its useful'
Ideally only links to uri's which might be there in a few
months time, but yes, I agree....
it 'as is' today.
I'll group it by subject over time and feed it to Tammy when
it is less empty.
I still haven't finished reading the mailing list since I started my
maternity leave, so forgive me if this has already been discussed.
I am putting together a Quick Guide for this interested in learning how
to participate since I get emails daily asking. It also helps define the
life cycle of a tutorial.
Please share your thoughts about it.
Fedora Documentation Project Quick Start Guide
Since reading the Documentation Guide can be a bit overwhelming at
first, read this page first to understand how to start participating and
the process used to add a tutorial to the project.
The first step is to choose whether you want to be a writer or an
editor. Refer to the project page for each role's definition (which is
still being developed). Editors must first be approved by the project
leader and must have experience with DocBook XML and the proper use of
tags since all editors must follow the same guidelines when reviewing
If you are chosen as an editor, your name is added to the project page,
and your job is to wait until writers are finished writing the tutorials
and need editing.
If you choose to be a writer, the follow process must be used:
* Refer to bug 129807 to see the list of tutorials already in progress
to make sure you do not select a duplicate.
* If you have an idea that is not in the list of docs in progress, open
a Bugzilla report with your idea and be sure to make bug 129807 depend
on it. Also, email the mailing list to let everyone know you are working
on it. If you can't think of an idea, refer to 129784 for a list of
ideas without owners.
* If you are not familiar with DocBook XML, read the Documentation Guide
to learn how to use this format. Tutorials must be submitted in this
format. Even if you are familiar with it, read the guide to learn how
tags are used for the project and to learn how to setup your file to
make it compatible with the CVS structure and the common entities file.
Once your file is ready, attach it to the bug report you created so that
an editor can be assigned to it.
* The editor will review your tutorial according to the editing
guidelines (which are in progress) and work with you to get them
* Once the writer and editor feel it is ready to be published to the
website, make bug 129722 depend on this bug so the project maintainer
can review it and post it to the website.
Once it is posted to the website, you are still responsible for
maintaining your tutorial. Until write access is available for CVS,
submit updates to your tutorial in the form of patches via Bugzilla so
that they can be applied.
I don't have an original copy of the 1918 edition of Strunk's book. Does
anyone on this list have one, which they might be able to use to scan
the title and verso pages for me? My eos-guide is finished, and I've
constructed a couple Makefile changes that allow me to build either the
1918 original or patch to build a (still forthcoming) FDP edition. I'd
like to send the original sources for the 1918 edition to Project
Gutenberg and they require the aforementioned scans.
Paul W. Frields, RHCE
I have a new, improved version of the updfstab-tutorial (soon to be
renamed) available. If you visit <http://docs.frields.org> you'll find
instructions for grabbing the latest version of my docs from my
subversion (SVN) server.
Dave Pawson spent some valuable time giving me comments and input which
(hopefully) is incorporated in the new version.
N.B. that my SVN server is not intended as a repository for anyone's
work except that which I'm doing myself, or on which I'm collaborating
with others. I found myself doing work on these docs both at home and
away, and got really tired of the revision control, updating the Web
site with new tarballs, etc. I'm sure every developer is smart enough to
solve the problem before it crops up, but since I'm not much of a
developer this was my first foray into RCS/SCCS/CVS/SVN, et al.
If someone has a problem with my instructions or getting the stuff, I
hope you'll let me know so I can fix it. Currently it works for me at
work and home. The anonymous access is, of course, read-only.
I've been told that ViewCVS works with SVN now, but I haven't been able
to make it work. The best I get is generation of a web page that
basically just generates a directory listing of the Berkeley db files --
basically useless as a Web interface. And I think I broke that, in any
case. But at least I still have both pieces. :-)
Tech help will gladly be accepted off-list, since it will likely bore
the subscribers to tears or violence.
Paul W. Frields, RHCE
My maternity leave ends this month, so I am going through the Fedora
docs bugs to start getting back in the swing of things. After that, I'll
go through the mailing list to read about what I have missed. So far,
here is a summary of the bug reports:
Bug #129784 has been created to track docs ideas without owners
Bug #129807 has been created to track docs in progress with a writer
assigned to it
A new bug report must be submitted for any new docs or docs changes so
we can keep track of them (these should also be listed as blockers for
I have fixed the following bugs:
122665, 123258, 123267, 125751, 125754, 129005
A new version of the Documentation Guide will appear on the website
shortly. It is just a maintenance release after fixing the previously