Hi all,
I'm just learning about this corner of the Fedora world. :-) I'm wondering what you Fedora documenters have been working on, who's involved, what the frustrations are, and what plans you'd like to turn into reality. I did notice Stuart's work on the Fedora Install Guide - very cool - and no doubt there is a lot of other work that needs recognition and integration.
Thanks for your efforts - how can I help with them? -- Elliot
On Tue, 2005-03-08 at 18:26 -0500, Elliot Lee wrote:
Hi all,
I'm just learning about this corner of the Fedora world. :-) I'm wondering what you Fedora documenters have been working on, who's involved, what the frustrations are, and what plans you'd like to turn into reality. I did notice Stuart's work on the Fedora Install Guide - very cool - and no doubt there is a lot of other work that needs recognition and integration.
Thanks for your efforts - how can I help with them?
Got a few hours? Hee hee. I'll try to be brief.
Our biggest challenge is that we started with no documentation (practically), and it is difficult to write everything from scratch. We're working on this.
One elephant-in-the-room is the release notes. Currently these are being handled by John Ha, technical lead of the docs team at RH, but these really should be a community effort. We need to do some serious thinking about how this could be done modularly by the Fedora developers with docs help. A Wiki that gets contributed to as we go, edited by this group, and dumped to plain XML for the install?
Another challenge is the toolchain has problems with PDF output. This is something we are working on internally on the RH docs team, but I would love to see this handled via the community. If we identify fop as the processor of choice, we will need to get it compiled using gcj and someone will need to maintain the package for Fedora.
The docs we are working on are primarily how-to/tutorial types. This is mainly because it's a PITA to maintain a full length guide by yourself, especially if you aren't being paid for your (significant) time. We have been trying to be creative with modularizing docs such as the Installation Guide, so multiple people can write and maintain it. This is still in the baby-steps stage.
When we have access to the docs CVS for outside contributors, there are a few that are ready to put their stuff in CVS. We have discussed this off-list, so I'm just adding this as an item.
Is that enough to chew on for now? I'm sure I'll think of more later.
I'm always camped on #fedora-docs on irc.freenode.net, if anyone wants to discuss this further that way; I'll report anything useful back to the list.
BTW, I think I'm done with all the craziness for a while, so am again gung-ho for solving our problems and moving forward with our plans. Thanks, Elliot, for dropping in to help.
- Karsten
Note: If I am jumping the gun and there is something else going on, now is the time to speak. :)
On Tue, 2005-03-08 at 16:16 -0800, Karsten Wade wrote:
One elephant-in-the-room is the release notes. Currently these are being handled by John Ha, technical lead of the docs team at RH, but these really should be a community effort. We need to do some serious thinking about how this could be done modularly by the Fedora developers with docs help. A Wiki that gets contributed to as we go, edited by this group, and dumped to plain XML for the install?
Oops, I misspoke here. John is not doing Fedora release notes. FC relnotes are entirely a community affair at this point.
Time to figure out a different method.
Is there anyone interested in working on the relnotes? You get extra exposure to developers, if you don't have enough already :), learn lots of interesting and esoteric stuff, and often more know about a given test, rc, or release than you thought possible.
I'm looking into the Wiki at fedoraprojects.org, as it's the canonical for Fedora. My first proposal, therefore, is that we use the Wiki to create a release notes page for every test, rc, and release, and browbeat developers into contributing.
For the upcoming FC4test relnotes, we don't have time for a new method. This is a good time for anyone interested to step up.
For FC4t2, I volunteer to be accountable for getting the process, people, and relnotes together. I think we missed the boat on test1, but we can get a Wiki page started ASAP. I'll do that immediately, and start questioning folks on #fedora-devel about using that. Ideally we can get a bunch of developers to cobble together some notes that will get us through test1 without corrupting anyone's data. :(
- Karsten
docs@lists.stg.fedoraproject.org