docs March 2014

docs@lists.fedoraproject.org

15 participants
33 discussions

[Fedora Infrastructure] #3860: Test box for Publican 3
by fedora-badges 25 May '14

25 May '14

#3860: Test box for Publican 3 ----------------------+----------------------------------- Reporter: sparks | Owner: sysadmin-main-members Type: task | Status: new Priority: major | Milestone: Fedora 19 Component: Systems | Version: Test Severity: Normal | Keywords: Blocked By: | Blocking: Sensitive: 0 | ----------------------+----------------------------------- The Docs Project needs a test system setup for our docs.fp.o replacement. It needs to be on a EL 6 box with the optional channel activated. -- Ticket URL: <https://fedorahosted.org/fedora-infrastructure/ticket/3860> Fedora Infrastructure <http://fedoraproject.org/wiki/Infrastructure> Fedora Infrastructure Project for Bugs, feature requests and access to our source code.

1 14

New contributor
by Robert Kratky 02 Apr '14

02 Apr '14

Hello everybody, I'd like to join the Docs team and help where necessary. I've been using Linux for over 15 years, but I've only switched to Fedora about a year ago. So far, I've mostly been involved in various OSS l10n and promotional efforts. But I've joined Red Hat as a Technical Writer this February, so I thought I might as well make myself useful in the documentation area. I've just started working on ABRT docs with the upstream developers, so I'd like to make the most of that and improve the ABRT section in the Fedora docs. That said, I'm open to suggestions. Just point me in the right direction. Also, I'm fond of KDE, so if the 'KDE Plasma' Fedora.next product comes to fruition, I'd be happy to work with them on behalf of Docs. Cheers, Robert IRC: rkratky P.S. I'm an admin/editor of the http://fedora.cz website, so if you ever feel the need to share something with the Czech Fedora community, just ping me.

3 2

2014-03-31 Meeting Notes
by Zach Oglesby 31 Mar '14

31 Mar '14

==================================== #fedora-meeting: Docs Weekly Meeting ==================================== Meeting started by zoglesby at 14:00:18 UTC. The full logs are available at http://meetbot.fedoraproject.org/fedora-meeting/2014-03-31/docs.2014-03-31-… . Meeting summary --------------- * Roll Call (zoglesby, 14:00:39) * Participants are reminded to make liberal use of #info #link #help in order to make the minutes "more better" (zoglesby, 14:01:20) * New Writers (zoglesby, 14:05:01) * SEO with DocBook & Publican (zoglesby, 14:07:37) * ACTION: lnovich to talk to Rudi about SEO for Docbook and Publican (zoglesby, 14:09:18) * ACTION: lnovich to find notes about SEO, will talk about it again next week (zoglesby, 14:10:07) * Publican/Publishing (zoglesby, 14:11:31) * https://fedoraproject.org/wiki/Building_the_docs_site (jsmith, 14:16:53) * LINK: https://fedoraproject.org/wiki/Building_the_docs_site (zoglesby, 14:17:10) * ACTION: jsmith to test publishing in a new VM (zoglesby, 14:17:30) * see nb if you want a openstack VM to test with (nb, 14:22:11) * randomuser is working on ansible setup for the new server (zoglesby, 14:24:45) * New Writers redux (zoglesby, 14:27:36) * LINK: https://fedoraproject.org/wiki/How_to_contribute_to_Docs (zoglesby, 14:28:12) * Fedora.next Product Updates (zoglesby, 14:36:10) * ACTION: jsmith to talk to the Cloud WG about docs (zoglesby, 14:39:09) * ACTION: jsmith and Sparks to write up posts about the FAD (zoglesby, 14:39:34) * randomuser is here! (zoglesby, 14:39:41) * Guide Status (zoglesby, 14:45:10) * LINK: https://fedoraproject.org/wiki/Category:Docs_Project_tasks (zoglesby, 14:45:17) * ACTION: nb to blog about the FAD (zoglesby, 14:46:22) * nb and jsmith adding two factor topics to security guide (zoglesby, 14:50:08) * lnovich is working on new Virtualization Deployment and Admin (zoglesby, 14:50:40) * Outstanding BZ Tickets (zoglesby, 14:52:13) * LINK: http://tinyurl.com/lbrq84 (zoglesby, 14:52:20) * LINK: http://tinyurl.com/agh4mg6 (zoglesby, 14:52:45) * Changes for the release notes will be tracked in the original ticket's "Docs Contact" field (zoglesby, 14:56:08) * volunteers to cover changes will be solicited in future meetings, irc, mailing list, wherever we can find you (randomuser, 14:56:22) * Changes to guides will be tracked in deplicate bugs (zoglesby, 14:56:44) * Open floor discussion (zoglesby, 14:57:47) * ACTION: randomuser to mail list about tracking changes (zoglesby, 14:58:16) * thanks zoglesby for chairing the meeting (randomuser, 14:58:35) * Docs Office hours for Americas will be Thur at 1800 UTC (zoglesby, 15:00:19) Meeting ended at 15:00:36 UTC. Action Items ------------ * lnovich to talk to Rudi about SEO for Docbook and Publican * lnovich to find notes about SEO, will talk about it again next week * jsmith to test publishing in a new VM * jsmith to talk to the Cloud WG about docs * jsmith and Sparks to write up posts about the FAD * nb to blog about the FAD * randomuser to mail list about tracking changes Action Items, by person ----------------------- * jsmith * jsmith to test publishing in a new VM * jsmith to talk to the Cloud WG about docs * jsmith and Sparks to write up posts about the FAD * lnovich * lnovich to talk to Rudi about SEO for Docbook and Publican * lnovich to find notes about SEO, will talk about it again next week * nb * nb to blog about the FAD * randomuser * randomuser to mail list about tracking changes * Sparks * jsmith and Sparks to write up posts about the FAD * **UNASSIGNED** * (none) People Present (lines said) --------------------------- * zoglesby (83) * jsmith (35) * lnovich (33) * randomuser (20) * nb (15) * Sparks (11) * rkratky (10) * jjmcd (6) * zodbot (5) * ciupicri (2) * yruseva (1) * pbokoc (1) * sclark (1) * pkovar (1) * Capesteve (1)

1 0

Fedora Docs Meeting Reminder 31MAR2014, with apologies
by Pete Travis 31 Mar '14

31 Mar '14

As usual, the Fedora Docs meeting is scheduled for 1400UTC in #fedora-meeting on freenode. I realized today that *someone* had scheduled an appointment for me during the meeting time, probably because they forgot about the daylight savings time switch when scheduling moths ago. Who has two thumbs and messed up? You know... If someone could chair the meeting in my absence, I would appreciate it. -- -- Pete Travis - Fedora Docs Project Leader - 'randomuser' on freenode - immanetize(a)fedoraproject.org

1 0

Fedora Docs FAD 2014 Action Summary 2000!
by Pete Travis 28 Mar '14

28 Mar '14

Thanks to everyone who participated in the FAD, I had a great time and enjoyed meeting everyone. I've just gone through the minutes and memories and put together a short summary of actionable stuff. Fedora Products: - jreznik will help get the WGs talking about docs - jsmith to track Cloud product - zoglesby to track Server product - pkovar is already tracking env-and-stacks - I will track Workstation product Publishing/infra: - jsmith and I started hacking on docs backend instance, jsmith made progress then and since. authorized_keys is manually maintained, ping nb if you are in sysadmin-docs and want to play along. - some of our trac instances don't mail. nb will look into it. - Sparks updated https://fedoraproject.org/wiki/Publishing_a_document_with_Publican#Publishi… - publishing translations means an extra step! check the doc. - The publican-fedora-web brand *might* be broken. We aren't sure if we are building the site properly yet. Videos: - everyone agreed that some videos would be nice - As I write this, I'm not sure if we had consensus on user facing videos or Docs facing videos - Sparks is going to ping the fedora design list about video production skills Cookbook: - I started a new book, the "Fedora Cookbook". We can put short articles that don't fit anywhere else in there. - The cookbook has rudimentary templates for people to fill out - submissions to follow review process, be part of mentorship program - Once this gets rolling, *please* help submitters see reviews then published results and keep the turnaround time low. Guides: - Sparks ressurected the Jargon Guide. - Laura gave us some good info on meta tags, and promised more. - We talked a bit about improving search presence. See below about blogs. - We discussed a mentoring process quite a bit. Other than pairing off mentors and new conrtributors, I don't recall any formalized mentoring stuff. We should continue to discuss this. New Contributors: - We agreed to encourage submissions on any topic. - Submissions will be reviewed for writing technique, etc - reviewer will then forward to an existing guide, new guide, or the cookbook - Docs lead should regularly send out check-in emails for new writers - Meetings will have a new writer topic on the standing agenda - Laura was very interested in persuing contributions from technical writing school sturents. Everyone thought that was a good idea and encouraged her to do that :) Documentation Guide: - Sparks added style guide content from the wiki - jsmith started working on a great intro guide with accompanying workbook - I made a note to add something about yelp - I did add an introduction to the group Meta: - We need to have more visibility in the project! - Docs people should write blogs and such and submit to planet.fedoraproject.org - Being involved in other groups is a good idea - {{Moved_to_guide}} wiki template created for outdated wiki content - We are sad that the docs-qa process isn't happening

2 1

2014-03-27 Docs Office Hours Notes
by Zach Oglesby 27 Mar '14

27 Mar '14

=============================== #fedora-docs: Docs Office Hours =============================== Meeting started by zoglesby at 18:01:53 UTC. The full logs are available at http://meetbot.fedoraproject.org/fedora-docs/2014-03-27/docs.2014-03-27-18.… Meeting summary --------------- * randomuser is here (randomuser, 18:02:36) * Office Hours are from 1800 - 1900 UTC (zoglesby, 18:03:11) * If you have questions or issues for Docs fell free to join the conversation (zoglesby, 18:09:11) * jhradilek waves. (jhradilek, 18:12:58) * Sparks and jsmith have joined (randomuser, 18:32:38) * AGREED: Change process will involve us using the Docs Contact BZ field for RNs tracking (randomuser, 19:07:12) * randomuser will not be cloning RN tracking bugs (randomuser, 19:08:04) Meeting ended at 19:12:13 UTC. Action Items ------------ Action Items, by person ----------------------- * **UNASSIGNED** * (none) People Present (lines said) --------------------------- * randomuser (40) * zoglesby (28) * jhradilek (13) * Sparks (7) * zodbot (5) * jsmith (4)

1 0

[Fedocal] Reminder meeting : Docs Office Hours ( Americas )
by Pete Travis 27 Mar '14

27 Mar '14

Dear all, You are kindly invited to the meeting: Docs Office Hours ( Americas ) on 2014-03-27 from 12:00:00 to 13:00:00 US/Mountain At #fedora-docs The meeting will be about: Office hours for Fedora Docs contributors. Stop in to #fedora-docs for help with writing documentation or just to schmooze with the Docs community. Bring your own cake. More information available at: [https://docs.fedoraproject.org](https://docs.fedoraproject.org) Source: https://apps.fedoraproject.org/calendar//meeting/315/

1 0

Publican testing woes
by Ruediger Landmann 26 Mar '14

26 Mar '14

Hi folks; First, a huge apology for my unresponsiveness over the last few weeks. It's hard for me to admit when I'm stretched beyond my ability to help out, especially when it's not clear when time will be available again. So, I'm very sorry for the frustration and disappointment I've caused. If I couldn't help, I should at the very least have communicated that openly. I'm also sorry that the website building instructions in the Publican User Guide didn't work as expected; Jeff and I are puzzled by this, because nothing about this process has changed lately. That said, even if the instructions are technically correct, they're useless if people can't follow them to get to a working instance. So, what next? I am still extremely stretched, both at work and at home, so my availability is likely to be patchy into the near future I think the best help I can be is to work on a few small tasks that can keep us moving forward. To that end, I'm going to verify the Publican website installation instructions and hoping that other folks can replicate what I'm doing, first on test boxes, and then, when we're comfortable, in production. I hope that we can avoid a situation where only one person knows how to do these things! I'll use a page on the wiki to track my progress, which maybe later can form the blueprint of how to re-create or recover this system if necessary: https://fedoraproject.org/wiki/Building_the_docs_site Once again, my sincere apologies for letting you all down recently. Cheers Rudi

5 4

References to external resources
by Jan Rusnacko 24 Mar '14

24 Mar '14

Hello, I am looking into the preferred way how to make references to external resources. So far, I have used separate section with itemizedlist, very much like: https://docs.fedoraproject.org/en-US/index.html Downside is that references are attached to the whole section. In case I want to refer to external resource from the text, I could use footnotes like in: https://docs.fedoraproject.org/en-US/Fedora/19/html/Security_Guide/chap-Sec… These are barely visible and don`t work well in text - see footnote [1] or [2] in Security Guide above. The only other way I can now think of is to verbosely refer to external resources, e.g. "... (see RFC 2616)" with ulink to rfc. However, I also like to keep all relevant references together, so I would also update References section, which works but its not a footnote, so lacks backreference to text. What is your preferred way to make references ? Thank you, Jan

3 3

Self-introduction: Bara Ančincová
by Barbora Ančincová 24 Mar '14

24 Mar '14

Dear All, My name is Bara Ančincová and I'm from Czech republic. I've started using Linux five years ago (Ubuntu), now I run Fedora on my work and home laptop. And well, this is my way how to thank the Fedora community for really nice experience I have with this distribution. Regarding computer skills, I'm familiar with basic administration of Fedora, Red Hat Enterprise Linux, and Ubuntu. In addition, I use git, DockBook, and Publican on a daily basis at work. I had some introduction to programming using bash and Python. I work as a technical writer in Red Hat and mainly contribute to the SELinux guide and to the Installation guide. So I could start helping with these two :) The only thing is, that at this time, I'm a little bit busy with writing my master thesis, so I will be able to dedicate more time to Fedora when I finish it (hopefully in April/May). Look forward to working with you guys :) Cheers, Bara

3 2

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs March 2014