docs October 2005

docs@lists.fedoraproject.org

25 participants
35 discussions

Self-Introduction: Andrew Martynov
by Andrew Martynov 02 Nov '05

02 Nov '05

Full Name: Andrew Martynov City & Country: Moscow, Russian Federation (GMT+0300) Profession: Trainer, Support Engineer Company: Inventa Your goals in the Fedora Project: Translation of Docs of Fedora Project into Russian language Historical qualifications: - maintainer of FC translation project into Russian - paticipant of translation RHEL manuals at www.rhd.ru/docs/ Computer skills: - linux user since 1999 - RHCE/RHCX certifications GPG KeyID and fingerprint: pub 1024D/30E45693 2005-03-18 Andrew Martynov <andrewm(a)inventa.ru> Key fingerprint = 0AF4 0070 E8A7 8C14 F9E0 97D9 320E 10AB 30E4 5693 sub 2048g/37A9C84D 2005-03-18 [expires: 2010-03-17] Other Details: fedoraproject.org wiki username: AndrewMartynov contact e-mail: andrewm(a)inventa.ru -- Andrew Martynov Inventa phone +7(095)7758777 fax +7(095)9270981 http://www.rhd.ru andrewm(a)inventa.ru

2 2

RFC: RPM Changelog thoughts
by Tommy Reynolds 01 Nov '05

01 Nov '05

I'm looking at the RPM packaging steps that Paul has done. AIUI, he uses a small python script to pick the changelog information out of the document's XML. Cool idea. My question is this: should we build the RPM changelog from the XML content or from the CVS check-in log? Using the XML info is way cool, but we can get more file-specific information from the CVS log. I think developers, er, RPM users, would like the additional details. Opinions? Cheers

3 5

Fedora websites mailing list and Wiki ownership
by Rahul Sundaram 01 Nov '05

01 Nov '05

Hi We have been managing feedback on the official Fedora websites, currently http://fedora.redhat.com and http://fedoraproject.org/wiki through bugzilla and discussions in the marketing list. It makes sense to have a independent mailing list -> fedora-websites-list which can also be used for discussing wiki pages. The wiki has good amount of community buy-in and the amount of content being added is growing rapidly. While this is indeed a positive development we need to make sure the content is organized and kept updated. Patrick Barnes has been keeping a good eye on this in general and I guess we can declare him the wiki master which is essentially the role he is performing .Going ahead, it might be a good idea to introduce a concept of "ownership" to each of the wiki pages. Every page would have a comment on top which declares the owner. Everyone in the edit group should have their own wiki pages filled out with atleast the contact information . Every page is also subscribed atleast by the owner of that page to monitor changes and keep the content relevant and updated. This process would help us make sure that unmaintained pages are marked as such and provide hints to users on what could be potentially outdated. It would also provide a list of pages that new wiki users can take care of and it provides accountability for the wiki itself. Suggestions welcome. regards Rahul

4 4

translated screen image
by Yoshinari Takaoka 31 Oct '05

31 Oct '05

hi all. as you know, fedora installation guide has many figures, and they are english screen. i want to relpace them with translated (in my case, japanese) screen. can i commit translated images (i.e *-ja_JP.png, *-ja_JP.eps) to the install-guide/figs/ directory? -- Yoshinari Takaoka(mumumu@IRC) reversethis -> {gro} {tod} {umumum} {ta} {umumum}

3 2

The translation of legal notice
by SEKINE Tatsuo 31 Oct '05

31 Oct '05

Hi, Now I'm translating the release notes into Japanese. Unfortunately, Legal Notice written in English might lose its legality on some level in Japan. Then, I'm thinking about adding translated one into Appendix as a guide (i.e. not replacing English one). If it is possible, could I put some files under docs-common/common directory? -- SEKINE Tatsuo: tsekine(a)sdri.co.jp System Design & Research Inst. Co.,Ltd.

3 4

Tech writing position available...
by Edward C. Bailey 31 Oct '05

31 Oct '05

(Before the flames about off-topic/commercial/whatever posts start, be aware that, before posting, I asked Karsten if he thought this was an appropriate use of the list. His response was that he personally thought people might be interested in job opportunities, but felt my post would be a good opportunity for people to weigh in with their own thoughts on the matter.) ---------------------------------------------------------------------- rPath is currently searching for a technical writer to join our team. The person hired for this position will be responsible for documenting rPath's technologies, such as Conary and rBuilder. We're looking for people with: o A well-developed writing style o Experience documenting complex technical subject matter, from initial concept through final editing o Strong spelling, grammar, and writing o The ability to edit and perform peer reviews of others' work o At least two years of recent Linux experience o Proven expertise in DocBook (XML or SGML), and HTML o Familiarity with open source authoring tools for the above formats o The ability to thrive in a fast-paced work environment (this is a startup, after all) Any of the following would be a definite plus: o Linux system administration experience -- even if it's just your own system(s) o Familiarity with one or more software packaging technologies (such as Conary, RPM, and dpkg) o Knowledge of XSL/XSLT o CSS experience o Familiarity with wikis o Programming experience (Python preferably) Writing samples will be requested, so be prepared to give us online pointers, emails bulging with attached PDFs, or even offer to send us a FedEx'ed package full of manuals. This position is located in Raleigh, NC -- if you're not local, you must be willing to relocate. Interested? Get in touch with us via this page: http://www.rpath.com/corp/about/employment/ -- Ed Bailey http://public.xdi.org/=edward.c.bailey rPath, Inc. http://www.rpath.com/

4 3

FC5 test1 relnotes make problem(two xml file broken)
by Yoshinari Takaoka 30 Oct '05

30 Oct '05

hi, all. i checked out fc5 test1 relnotes, and tried to make with the following steps. ---- $ echo $CVSROOT :ext:username@cvs.fedora.redhat.com:/cvs/docs $ cvs co -r FC-5-TEST1-TRANS-FREEZE -d release-notes-FC5test1 release-notes $ cvs co docs-common $ cd release-notes-FC5test1 $ cp RELEASE-NOTES-en.xml RELEASE-NOTES-ja.xml $ vi Makefile ....here, i editied "LANGUAGES" parameter, and replaced 'en' with 'ja'. and tried to make, but i got the following error. ---- $ make LANG=ja.UTF-8 xmlto html -x ../docs-common/xsl/main-html.xsl -o RELEASE-NOTES-ja RELEASE-NOTES-ja.xml xmlto: input does not validate (status 1) /home/mumumu/work/release-notes-FC5test1/package-notes-en.xml:40: parser error : expected '>' <caution> ^ /home/mumumu/work/release-notes-FC5test1/package-notes-en.xml:288: parser error : chunk is not well balanced ^ /home/mumumu/work/release-notes-FC5test1/RELEASE-NOTES-ja.xml:74: parser error : chunk is not well balanced &PACKAGE-NOTES; ^ make: *** [RELEASE-NOTES-ja/index.html] error 1 ---- this error was caused because "para" tag was not closed in package-notes-en.xml line 39. http://cvs.fedora.redhat.com/viewcvs/release-notes/package-notes-en.xml?ann… i fixed this and tried once more. but i got error again. ---- $ make LANG=ja.UTF-8 xmlto html -x ../docs-common/xsl/main-html.xsl -o RELEASE-NOTES-ja RELEASE-NOTES-ja.xml xmlto: input does not validate (status 1) /home/mumumu/work/release-notes-FC5test1/package-movement-en.xml:1055: parser error : Opening and ending tag mismatch: para line 1052 and emphasis </emphasis>) ^ /home/mumumu/work/release-notes-FC5test1/package-movement-en.xml:1056: parser error : Opening and ending tag mismatch: section line 1044 and para </para> ^ /home/mumumu/work/release-notes-FC5test1/package-movement-en.xml:1065: parser error : chunk is not well balanced </section> ^ /home/mumumu/work/release-notes-FC5test1/package-movement-en.xml:1065: parser error : chunk is not well balanced </section> ^ /home/mumumu/work/release-notes-FC5test1/RELEASE-NOTES-ja.xml:76: parser error : chunk is not well balanced &PACKAGE-MOVEMENT; ^ make: *** [RELEASE-NOTES-ja/index.html] error 1 ---- this is because the start "emphasis" tag is missing in package-movement-en.xml line 1055. http://cvs.fedora.redhat.com/viewcvs/release-notes/package-movement-en.xml?… i fixed this and tried again. this time, "make" worked fine and i could get release-note-ja directory and tar archive. Regards. -- Yoshinari Takaoka(mumumu@IRC) reversethis -> {gro} {tod} {umumum} {ta} {umumum}

3 5

Guides content frozen for trans delayed?
by Yoshinari Takaoka 29 Oct '05

29 Oct '05

hi all. according to DocsProject/Schedule, fedora installation guide contents freeze for trans is Oct 28, but its CVS contents are unchanged. http://fedoraproject.org/wiki/DocsProject/Schedule schedule is delayed? Regards. -- Yoshinari Takaoka(mumumu@IRC) reversethis -> {gro} {tod} {umumum} {ta} {umumum}

2 1

Local document customizations
by James Laska 28 Oct '05

28 Oct '05

Hi folks, Some of our process documents can become somewhat large, which lends well to the chunked html output. Taking that a step further we've found it helpful to have 2 toc settings where the main table of contents only goes one level deep (chapter). Once you click on a chapter you then see the detailed toc for that section. This has received some good mileage and seems break up a document into manageable chunks. To see an example of the output see http://people.redhat.com/~jlaska/documentation-guide-en/ . Curious what folks think about this, is there a way to allow doc writers to make this customization without modifying main-html.xsl? Thanks, James -- ========================================== James Laska -- jlaska(a)redhat.com Quality Engineering -- Red Hat, Inc. ==========================================

2 3

minutes FDSCo 25 Oct. 2005
by Karsten Wade 26 Oct '05

26 Oct '05

Today we were not able to have a quorum, but no decisions came up that required one. :) Attendees: ========== Stuart Elliss Karsten Wade Tommy Reynolds Updated activities: =================== http://fedoraproject.org/wiki/DocsProject/FedoraDocsSchedule Highlights: =========== * Tommy has worked with Tim Waugh to get changes to xmlto upstream. The changes let us use xmlto with Saxon, and defaults to xsltproc if Saxon is not installed. Meanwhile, the status of FOP is still in question. * Elliot is working on DocsRawhide, which will pull from CVS, build, and publish documentation. * Beat writing coverage has increased, thanks to the participation of more active developers. * Conversion of Wiki to XML went fairly well for the test1 relnotes. Patrick did some work to automate the export of the URL. We have a big challenge keeping the XML in CVS and the Wiki in sync. We need to work out how to have a canonical, meaning that syncing needs to be seamless. * The RPM Guide is in CVS. Help is needed to clean up the XML, then work can begin on updating the content. ## 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/

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs October 2005