docs April 2005

docs@lists.stg.fedoraproject.org

36 participants
79 discussions

Man page format to Docbook XML for New Authors
by Gavin Henry 22 Apr '05

22 Apr '05

Dear Guys, I recently, with the help of Stefan, tagged up the whole of: http://www.backupcentral.com/amanda.html To give: http://www.amanda.org/docs/using.html However, to get the manpages into docbook: http://www.amanda.org/docs/AMANDA-manpages.html We used Eric Raymonds Doclifter, which as you can see by the above results it's very good: http://www.catb.org/~esr/doclifter/ Man page format is easy to write. Thoughts? -- Kind Regards, Gavin Henry. Managing Director. T +44 (0) 1224 279484 M +44 (0) 7930 323266 F +44 (0) 1224 742001 E ghenry(a)suretecsystems.com Open Source. Open Solutions(tm). http://www.suretecsystems.com/

6 6

Re: Linking to mp3 decoders
by Karsten Wade 21 Apr '05

21 Apr '05

(moving this discussion on-list for clarity) On Thu, 2005-04-21 at 12:48 +0530, Rahul Sundaram wrote: > Hi > > I found this article on the Red Hat website which explicitly links to > mp3 decoders. http://www.redhat.com/advice/speaks_80mm.html. If this is > legally safe we might as well as bless fedorafaq(.org) as our official > one and point it in our release notes or even download the mp3 decoder > automatically from the net when the user tries to play an mp3 file. We > might to have get feedback from our legal department on this but I > thought I would let you know Word I got today was that we are OK to link to a site that discusses these issues, as that page does. We cannot link to a site that directly offers the questionable items for download. That could be "contributory infringement." So, we cannot necessarily use the content from FedoraFAQ as-is ourselves, but we can link to it, saying, "For information about using MP3s, this site discusses that." As long as they don't have direct links to packages that might contain infringing materials. Then we can't link to them. Clear as mud? We need to review how FedoraFAQ.org handles these items _before_ using them as a reference. - 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/

2 1

png2eps script
by Tammy Fox 21 Apr '05

21 Apr '05

Hi everyone, In anticipation of us getting PDF production to work, I've committed the script png2eps in a new scripts directory in the fedora-docs CVS module. It allows you to convert a PNG to EPS. To use: png2eps --width=<width> <image-file>.png If you don't specify a width in pixels, 4 is used by default, which is the maximum width I usually use for a US letter size PDF. If an EPS already exists in the same directory and you don't specify a width, it will use the width for the existing EPS file. Karsten, this is based on the one we use internally, but I modified it to produce color EPS files. Cheers, Tammy -- Learn, Network and Experience Open Source. Red Hat Summit, New Orleans 2005 http://www.redhat.com/promo/summit/

1 0

Fwd: FYI: Choosing an XML Editor
by Gavin Henry 20 Apr '05

20 Apr '05

---------- Forwarded Message ---------- Subject: FYI: Choosing an XML Editor Date: Wednesday 20 Apr 2005 17:25 From: Saqib Ali <docbook.xml(a)gmail.com> To: "discuss(a)en.tldp.org" <discuss(a)en.tldp.org>, docbook(a)en.tldp.org A review of XML editors has just been published by the Arts and Humanities Data Service. Please see http://www.xml-dev.com/blog/index.php#121 for info ______________________ http://lists.tldp.org/ ------------------------------------------------------- -- Kind Regards, Gavin Henry. Managing Director. T +44 (0) 1224 279484 M +44 (0) 7930 323266 F +44 (0) 1224 742001 E ghenry(a)suretecsystems.com Open Source. Open Solutions(tm). http://www.suretecsystems.com/

3 2

Re: FC4 Release Notes and translations
by Andrew Martynov 20 Apr '05

20 Apr '05

Hello, Karsten! Unfortunaly no one Release Notes for Fedora Core was not translated yet. I previously have not experiense in cooperation with Red Hat team in translation RelNotes and can not describe the traditional way for such translation process. From my point of view at least three days is required for preparing good translation. Best regards, Andrew Martynov On Tue, 19 Apr 2005 at 02:59 -0700 Karsten Wade wrote >On Fri, 2005-04-15 at 17:22 +0400, Andrew Martynov wrote: > > >>Hello, >> >>I have read this list for couple of months but I did not >>see the way to translate the future FC4 Release Notes. >> >>We can translate current Wiki document >>http://fedoraproject.org/wiki/FedoraDocs_2fReleaseNotes_2fCore4Test1 >>but obviously we got a problem with version control and so on... >> >> > >That's very out of date, and even the test2 version is sparse of >important information. > > > >>If there are no any suitable methods to organize >>transation process could I ask the chief editor >>to announce the readiness of this Release Notes >>in fedora-trans-list(a)redhat.com and give few days >>for translators to localize it. >> >>I suppose such localized Release Notes will be >>very usefull for non-English speaking people. >> >> > >Well, I suppose something is better than nothing. > >I say that just because I don't like the state the relnotes are in, and >looking to be for FC 4. > >How are the translated release notes dealt with traditionally? Does the >originating writer hand them to the translators prior to release, and by >how many days? > >- Karsten > > -- Best regards, Andrew Martynov Inventa phone +7(095)924-8651 fax +7(095)927-0981 andrewm(a)inventa.ru http://www.inventa.ru

1 0

Suggestion for doc format to be submitted by new authors
by Gavin Henry 19 Apr '05

19 Apr '05

POD: http://perldoc.perl.org/perlpod.html http://perldoc.perl.org/search.html?q=pod -- Kind Regards, Gavin Henry. Managing Director. T +44 (0) 1224 279484 M +44 (0) 7930 323266 F +44 (0) 1224 742001 E ghenry(a)suretecsystems.com Open Source. Open Solutions(tm). http://www.suretecsystems.com/

2 2

FC4 Release Notes and translations
by Andrew Martynov 19 Apr '05

19 Apr '05

Hello, I have read this list for couple of months but I did not see the way to translate the future FC4 Release Notes. We can translate current Wiki document http://fedoraproject.org/wiki/FedoraDocs_2fReleaseNotes_2fCore4Test1 but obviously we got a problem with version control and so on... If there are no any suitable methods to organize transation process could I ask the chief editor to announce the readiness of this Release Notes in fedora-trans-list(a)redhat.com and give few days for translators to localize it. I suppose such localized Release Notes will be very usefull for non-English speaking people. -- Best regards, Andrew Martynov RHCE/RHCX Inventa

2 1

[Doc review] - Configuring updates (bug 155180)
by Stuart Ellis 18 Apr '05

18 Apr '05

This is a draft tutorial using up2date and the alert icon: HTML: http://www.mythic-beasts.com/~hobb/fedora/using-up2date-en/ DocBook source: http://www.mythic-beasts.com/~hobb/fedora/fedora-using- up2date-0.2.tar.gz It's intended for new users, so that they can get their systems updating before moving on to the hard stuff with yum.

2 3

[Doc review] - Software management with yum (bug 155190)
by Stuart Ellis 17 Apr '05

17 Apr '05

This is a trimmed and tweaked version of the software management guide posted previously. It starts with a short overview of the concepts and tools for new users, and then describes yum. HTML: http://www.mythic-beasts.com/~hobb/fedora/yum-software-management- en/ DocBook source: http://www.mythic-beasts.com/~hobb/fedora/fedora-yum-software- management-0.2.tar.gz

1 0

[RFC] Legacy documentation
by Karsten Wade 17 Apr '05

17 Apr '05

I've been wondering about this for a while, so when Stuart brought up the age of the Keeping Up to Date tutorial: http://fedora.redhat.com/docs/updates/ today on #fedora-docs, I figured it was time to open this discussion. I'm hoping you are interested in taking over some documentation. We have a few documents that are FC2 specific and are going to be orphaned when FC2 moves over to the Legacy Project. The Docs Project (FDP) follows the Fedora Core release and maintenance schedule, meaning when a version of Core goes to the Legacy Project, the docs should go with it. I'll list what those docs are (just a few), bring up some ideas about what can be done with them, and finish with a few useful URLs. ## The Docs: We'll have a list that is a bit longer for FC3 when that time comes. Keeping Up to Date (FC2) http://fedora.redhat.com/docs/updates/ We're likely to update this for FC4, if a writer pops up wanting it. Fedora Jargon Buster http://fedora.redhat.com/docs/jargon-buster/ This was written originally under FC1. It may not be out of date, but it hasn't been updated in six months. Package List for Fedora Core 2 http://fedora.redhat.com/docs/package-list/fc2/ I don't know anything about this or its value. Release notes for FC2 http://fedora.redhat.com/docs/release-notes/fc2/x86/ http://fedora.redhat.com/docs/release-notes/fc2/x86_64/ Not sure that you'd ever want to update them, and we can certainly leave them in place. For relnotes in particular it's a good thing to keep old ones around. Fedora Core 2 SELinux FAQ http://fedora.redhat.com/docs/selinux-faq-fc2/ SELinux had a breakdown in updates to FC2, and this FAQ says at the top to upgrade to FC3. However, if anyone is trying to work with SELinux in FC2, this FAQ might be valuable. ## What to Do? I'm just throwing out a few ideas, which may even be somewhat exclusive of each other. 1. Legacy Docs could be a sub-project of the Docs Project. There is no rule that says what is in our purview. I keep the nose of the project turned in the direction Fedora Core is going, but the rest of the head can be doing other things at the same time. Currently, we don't have enough writers to work on new documents that are needed for FC. I don't know of anyone interested in the Legacy docs. IMO, maintenance of a set of Legacy docs is likely to be easier than a doc that tracks something with an active update schedule in FC. I had this with the SELinux FAQ. It was very active during the early parts of the release, and tapered off as rawhide become more of the next version. This means that one or two people could maintain quite a large set of docs. This could be great experience for someone interested in technical writing, open source projects, or need to support a legacy app. By integrating the efforts, current docs could be written with Legacy needs in mind. Whatever those turn out to be. 2. Legacy Project can form the Legacy Docs as a sub-project. This is more of a throw over the wall scheme. I'd recommend that the FDP remain available to help train on the tools. Since the Legacy Project is going to need to staff the a documentation effort with writers, you might as well keep them close to the rest of the project. 3. Legacy Project could cherry-pick from the versioned docs. The FDP would likely keep the outdated docs available, but mark them clearly as not current. The FDP will help get Legacy writers up to speed, mainly through our standard docs and procedures, then mailing list support where needed. ## URLs FDP page: http://fedora.redhat.com/projects/docs/ For an overview of the docs process: http://fedora.redhat.com/participate/documentation-quick-start/ Our Wiki page is still being added to, we'll be adding process documentation through this medium: http://fedoraproject.org/wiki/DocsProject Thanks - 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/

6 8

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs April 2005