docs August 2013

docs@lists.stg.fedoraproject.org

26 participants
41 discussions

Defensive and secure coding guide: call for renaming files
by Jérôme Fenal 10 Oct '13

10 Oct '13

Hi all, The Defensive and coding guide sports an interesting and forgotten feature in its file organization: directories. Beyond directories, it also happens to show files having the same name (such as Language.xml, found in Python/, Java/, CXX/, C/, etc. or schema.xml). You tell me, that is what directories are for. Fair enough. The real issue here is that pushing .po resulting from those XML files to Transifex which only handles uniquely named resources in a flat hierarchy leads to a mess, where there is no predictibility in having the Language resource always the same on Transifex, depending how those are pushed. Could it be possible to rename all those files to unique names, ideally with the subdir as a prefix (such as CXX-Language.xml or C-schema.xml) so that we have unique resource names in Transifex? Furthermore, could we add a requirement to documentation authors in order to ensure that all XML files in their document hierarchy show unique names? Regards, J. -- Jérôme Fenal

5 11

[Bug 768731] Transifex file submissions disable f14 and enable f16
by Red Hat Bugzilla 30 Sep '13

30 Sep '13

https://bugzilla.redhat.com/show_bug.cgi?id=768731 --- Comment #17 from Eric Christensen <sparks(a)redhat.com> --- I only know of one other project that had its base (source) language that wasn't EN. The "problem" was solved by translating it to English and then to other languages. Unfortunately that is how our model is setup. Our expectation is that the translators will translate text from English to another language. This should limit someone's ability to write in their native language, though. There's just another hop involved. -- You are receiving this mail because: You are the assignee for the bug.

2 1

Long lines in Docbook sources
by Florian Weimer 09 Sep '13

09 Sep '13

Some Docbook XML files I've seen do not contain line breaks within paragraphs. These long lines are a bit unwieldy in line-based editors and also show up badly in line-based diffs. Is this XML source layout the preferred style, or would it be considered okay to wrap long lines as a separate change before making actual content changes? -- Florian Weimer / Red Hat Product Security Team

5 5

Self Introduction
by Samuel W. Flint 07 Sep '13

07 Sep '13

Well, I can't say I've done much writing in the past, or worked on any big name free-software projects, but I do have a bit of code up on the EmacsWiki. I have fairly advanced computer skills, no degree, but otherwise I do have programming and administrative skills. I have moderate people skills, and can speak well, having a firm grasp of the English language. I feel I am an excellent match for this project because I have an understanding of the English language and of the technical concepts required for it. Sam -- Sam Flint swflint(a)flintfam.org freenode: swflint (402) 517-8468 http://flintfam.org/~swflint BAFBF3FF

7 10

Self-Introduction: Isaac Rooskov - Zanata Product Manager
by Isaac Rooskov 03 Sep '13

03 Sep '13

Hi Fedora translators and writers :) My name is Isaac Rooskov. I am the new Product Manager for the Zanata translation tool, and I also supervise the localization and translation efforts for JBoss, Red Hat Enterprise Virtualization and Cloud business units at Red Hat. If you have any questions or feedback concerning Zanata I would love to hear them. I'm based in Brisbane, Australia, so if there is a slight delay in my responses that may be why ;) Thanks and I look forward to being apart of the Fedora community with you all. Isaac -- Isaac Rooskov Supervisor, Localization Services Product Manager, Zanata Red Hat

3 4

Publican 3 and our web repo
by Eric Christensen 29 Aug '13

29 Aug '13

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 I just realized the reason I couldn't publish an update to the Defensive Coding Guide was because I've upgraded to Fedora 19 which has Publican 3 as its offering. This causes several errors to occur when trying to install a book onto the web repo. I guess I have two questions: 1) Is there a workaround for this so we can publish things to the web using the latest version of Publican? 2) When will we be able to publish documents using koji? - -- Eric - -------------------------------------------------- Eric "Sparks" Christensen Fedora Project sparks(a)fedoraproject.org - sparks(a)redhat.com 097C 82C3 52DF C64A 50C2 E3A3 8076 ABDE 024B B3D1 - -------------------------------------------------- -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.14 (GNU/Linux) iQGcBAEBCgAGBQJSH08SAAoJEB/kgVGp2CYvz7EL/1dQZVT7dA+ffNPcrdPqSHPp v5zsrE3J76mDRP9xvS4Ch5LwDQimNYFwa8lKCr+oYONaHsadRCs/pF1tcYHNzKzX EGWtYN1aA1baZy0qzKTOYKbFlomPatAIljqgyAAOu4BYFwOY2HBuc0T8FWFwHLyM Db0ypnYG635N28ixaS2/ewAe8OwpIwiBc0+ZDS9bIdQdp2Z2tgbQgYSu/AWMDzVF nPGT6p0b6BDgaQ7BVJgRzHgiLJSR7Sd3eI4cMvAlZkpfL009T2pFEStQwG61XWhW u8Y9p5zFyqCBV/OMh2Bz/v6/c99H8Ciiv4q2aVU4kUpy1gbC62qpqb2UrQargjkO VBLat7nTduv14Urlci3Ly6e1KERCyFo6HemNOCElgNrRQ1p/Rmc+L23pu8OV8HNJ J4r4ix8zzV8o4MtNcvdLfgUc1/NuF8r9GRXIx8gSLdwZxFOsM4C2XQcZOCv7ERGn xOc71LGxVsgJP/Lj4jjZLCIodKs/XeWPOO6roF6WCA== =H5XG -----END PGP SIGNATURE-----

2 3

Greetings from a new member
by Benjamin Thompson 28 Aug '13

28 Aug '13

Okay, let's go down the bullet list from the wiki: Hi, my name is Benjamin Thompson and I go by Ben, my handle on FAS is "rumford". I'm in the US Eastern time zone, in northern Indiana, USA. My experience is in technical support, Python development including web2py, Linux administration, and I have a Bachelor of Arts degree in English. I am Linux+/LPIC-1 certified. In time, I plan to go up to LPIC-3 and RHCE. I've been using Linux as a desktop OS since about 2003. I'm looking to join the Fedora Project in order to hone my technical writing skills, and perhaps flex my coding or sysadmin muscles eventually as well. My aim is to make myself a more proficient, knowledgeable user/administrator of Linux operating systems. To start I would like to contribute documentation, no matter how small or seemingly inconsequential. The parts of the OS I am most interested in helping with are cryptographic and networking tools, although my knowledge level is not terribly deep yet on those subjects. My other passion is user-friendliness. Applications geared toward making the OS as a whole more approachable are of great interest to me. If documentation on any of these is lacking I would be quite happy to try and fill in the gaps. After finding some training and/or a sponsor, I look forward to contributing about 4 hours per week. I work full time sometimes up to 50 hours a week, but there is often enough time on the nights and weekends to put several hours in. I have lurked for quite some time. I've recently decided that I need to stop WISHING I was contributing and start making that a reality. I look forward to listening in on meetings in the coming weeks. Perhaps I can even contribute some documentation work for the Fedora 20 release.

1 0

Beats and Changes - Writers wanted!
by Pete Travis 27 Aug '13

27 Aug '13

Hello, Beats for Fedora 20 Release Notes are open. Take a look at https://fedoraproject.org/wiki/Category:Documentation_beats?rd=Docs/Beats , find something that interests you, and take a beat! If you do sign on, be sure to add your name to the appropriate column of the tracking table. More than one writer per beat is good, especially if they communicate, but zero writers for a beat is bad. You might also want to pick up the Changes bugs that apply in your beat, a new process for this release. I've created a number of bugzilla tickets to help track Changes in the next version of Fedora. Please pick some up! The Change process is outlined at https://fedoraproject.org/wiki/Changes/Policy and the current accepted proposals are at https://fedoraproject.org/wiki/Releases/20/ChangeSet . The are three tickets for each Change listed below: the Change tracker bug (CH), the bug for representing the change in the Release Notes (RN), and a bug against docs-requests to track impact of the Change on other guides. So, here's the process. Each Change page on the wiki has a "release notes owner" - that's us. Pick up the RN bug, and you are now the Release Notes contact for the Change. You'll be responsible for writing the changes into a beat on the wiki or directly to git, and ideally reviewing the copy with the Change owner. I like to make sure that the information is as actionable as possible, or at least refers the reader to actionable information. The Changes will also impact our existing Guides. Ideally, the same person taking the RN bug will take the DR bug as well. You'll be responsible for identifying sections of currently maintained guides that need updating because of the Change in question. I'm thinking a few choice grep invocations through your directory of docs repos should work in most cases. If you find something, open a new bug against the guide in question. The first round of tickets are those identified as System Wide Changes: ============================================ ARM as Primary Architecture CH: https://bugzilla.redhat.com/show_bug.cgi?id=998560 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001329 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001330 AppInstaller CH: https://bugzilla.redhat.com/show_bug.cgi?id=998562 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001335 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001336 Migrate to Bluez 5 CH: https://bugzilla.redhat.com/show_bug.cgi?id=998563 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001338 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001339 Boot 1.54 Uplift CH: https://bugzilla.redhat.com/show_bug.cgi?id=998564 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001341 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001342 Kdump with Secure Boot CH: https://bugzilla.redhat.com/show_bug.cgi?id=998565 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001343 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001344 SELinux Labeled NFS Support CH: https://bugzilla.redhat.com/show_bug.cgi?id=998566 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001345 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001346 NetworkManager Bonding CH: https://bugzilla.redhat.com/show_bug.cgi?id=998567 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001347 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001348 NetworkManager Bridging CH: https://bugzilla.redhat.com/show_bug.cgi?id=998568 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001349 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001352 No Default Sendmail CH: https://bugzilla.redhat.com/show_bug.cgi?id=998571 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001353 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001354 No Default Syslog CH: https://bugzilla.redhat.com/show_bug.cgi?id=998573 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001355 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001356 Python-setuptools update to 0.7 CH: https://bugzilla.redhat.com/show_bug.cgi?id=998574 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001358 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001359 Ruby on Rails 4.0 CH: https://bugzilla.redhat.com/show_bug.cgi?id=998578 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001361 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001362 Unversioned Docdirs CH: https://bugzilla.redhat.com/show_bug.cgi?id=998579 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001364 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001365 Visible Cloud CH: https://bugzilla.redhat.com/show_bug.cgi?id=998582 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001367 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001368 Web Assets CH: https://bugzilla.redhat.com/show_bug.cgi?id=998583 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001371 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001374 Perl 5.18 CH: https://bugzilla.redhat.com/show_bug.cgi?id=998584 RN: https://bugzilla.redhat.com/show_bug.cgi?id=1001375 DR: https://bugzilla.redhat.com/show_bug.cgi?id=1001377 -- -- Pete Travis - Fedora Docs Project Leader - 'randomuser' on freenode - immanetize(a)fedoraproject.org

2 2

Fedora Docs Meeting Minutes
by Pete Travis 26 Aug '13

26 Aug '13

==================================================================================================== #fedora-meeting: Docs Project Meeting - Agenda: https://fedoraproject.org/wiki/Docs_Project_meetings ==================================================================================================== Meeting started by randomuser` at 13:59:29 UTC. The full logs are available at http://meetbot.fedoraproject.org/fedora-meeting/2013-08-26/fedora_docs.2013… . Meeting summary --------------- * Roll Call (randomuser`, 13:59:29) * Follow up on last week's action items (10 minutes ) (randomuser`, 14:05:36) * Release Notes / Changes (randomuser`, 14:07:58) * Writers can create bugs for themselves to cover our part of the changes process at any time (randomuser`, 14:10:33) * ACTION: randomuser to announce open beats (randomuser`, 14:14:19) * ACTION: randomuser to start creating tracking bugs for Changes (randomuser`, 14:14:39) * Guide Status (randomuser`, 14:14:56) * LINK: https://badges.fedoraproject.org/user/1345 (jhradilek, 14:32:30) * Outstanding BZ tickets (randomuser`, 14:34:49) * LINK: http://tinyurl.com/lbrq84 (randomuser`, 14:35:03) * Open Floor (randomuser`, 14:43:51) Meeting ended at 14:59:55 UTC. Action Items ------------ * randomuser to announce open beats * randomuser to start creating tracking bugs for Changes Action Items, by person ----------------------- * **UNASSIGNED** * randomuser to announce open beats * randomuser to start creating tracking bugs for Changes People Present (lines said) --------------------------- * randomuser` (75) * lnovich (28) * Capesteve (15) * jhradilek (12) * jamielinux (10) * zoglesby (6) * croberts (6) * zodbot (5) * swflint (3) * jsmith (2) * jreznik (2) * pkovar (1) Generated by `MeetBot`_ 0.1.4 .. _`MeetBot`: http://wiki.debian.org/MeetBot -- -- Pete Travis - Fedora Docs Project Leader - 'randomuser' on freenode - immanetize(a)fedoraproject.org

1 0

Fedora Docs Meeting Reminder, 26 Aug 2013 1400 UTC
by Pete Travis 26 Aug '13

26 Aug '13

We're throwing a meeting in #fedora-meeting on freenode, 26 Aug 2013 at 1400 UTC. I hope everyone can attend. -- -- Pete Travis - Fedora Docs Project Leader - 'randomuser' on freenode - immanetize(a)fedoraproject.org

1 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs August 2013