Fedora Docs Weekly Meeting 20 July 2015
by Pete Travis
---------- Forwarded message ----------
From: <notifications(a)fedoraproject.org>
Date: Jul 20, 2015 9:59 AM
Subject: randomuser`'s meeting titled "Docs Project Meeting - Agenda:
https://fedoraproject.org/wiki/Docs_Project_meetings" ended in
#fedora-meeting
To: <meetingminutes(a)lists.fedoraproject.org>
Cc:
>
====================================================================================================
> #fedora-meeting: Docs Project Meeting - Agenda:
https://fedoraproject.org/wiki/Docs_Project_meetings
>
====================================================================================================
>
>
> Meeting started by randomuser` at 14:01:06 UTC. The full logs are
> available at
>
http://meetbot.fedoraproject.org/fedora-meeting/2015-07-20/fedora_docs.20...
> .
>
>
>
> Meeting summary
> ---------------
> * Roll Call (randomuser`, 14:01:06)
>
> * New Writers (randomuser`, 14:11:40)
>
> * Release Notes Beats (randomuser`, 14:14:45)
> * ACTION: randomuser to clear beats for F23 (randomuser`, 14:15:12)
> * ACTION: randomuser to hand out badges for F22 beat writing, already
> (randomuser`, 14:15:36)
> * LINK: https://fedoraproject.org/wiki/Releases/23/ChangeSet
> (randomuser`, 14:16:47)
> * F23 Alpha Freeze is in just over a week (randomuser`, 14:17:11)
> * ACTION: zoglesby to send Change summary to list, ask for Docs
> Contacts (randomuser`, 14:17:49)
> * LINK:
> https://fedorapeople.org/groups/schedule/f-23/f-23-docs-tasks.html
> (randomuser`, 14:18:47)
> * LINK: https://fedorapeople.org/groups/schedule/f-23/f-23-docs.ics
> (zoglesby, 14:19:49)
> * ACTION: randomuser to make list of beat writers while assigning
> badges and ask those people to keep beat writing (randomuser`,
> 14:22:00)
> * ACTION: randomuser to mail devel (devel-announce) after clearing
> beats (randomuser`, 14:23:48)
>
> * Publishing (randomuser`, 14:26:47)
>
> * Guide Status (randomuser`, 14:28:50)
> * smccann is fedora-izing the VADG (randomuser`, 14:34:07)
> * VDAG -Virtualization Deployment and Administration Guide (lnovich,
> 14:35:09)
> * LINK: https://fedoraproject.org/wiki/Virt_Deploy_Admin_Planning for
> VDAG planning (smccann, 14:37:02)
>
> * Outstanding BZ Tickets (randomuser`, 14:39:27)
> * LINK: http://tinyurl.com/lbrq84 (randomuser`, 14:39:45)
>
> * Open floor discussion (randomuser`, 14:43:54)
> * - office hours at 9AM EST Wed (lnovich, 14:53:22)
> * - same on thurs (lnovich, 14:53:38)
> * - Wed office hours will discuss the VDAG (lnovich, 14:54:02)
>
> Meeting ended at 14:57:05 UTC.
>
>
>
>
> Action Items
> ------------
> * randomuser to clear beats for F23
> * randomuser to hand out badges for F22 beat writing, already
> * zoglesby to send Change summary to list, ask for Docs Contacts
> * randomuser to make list of beat writers while assigning badges and ask
> those people to keep beat writing
> * randomuser to mail devel (devel-announce) after clearing beats
>
>
>
>
> Action Items, by person
> -----------------------
> * zoglesby
> * zoglesby to send Change summary to list, ask for Docs Contacts
> * **UNASSIGNED**
> * randomuser to clear beats for F23
> * randomuser to hand out badges for F22 beat writing, already
> * randomuser to make list of beat writers while assigning badges and
> ask those people to keep beat writing
> * randomuser to mail devel (devel-announce) after clearing beats
>
>
>
>
> People Present (lines said)
> ---------------------------
> * randomuser` (77)
> * grundblom (22)
> * lnovich (17)
> * bexelbie (17)
> * zoglesby (15)
> * smccann (10)
> * zodbot (6)
> * Capesteve (5)
> * jjmcd (2)
> * pbokoc (1)
> * kirsti (1)
> * pkovar (1)
>
>
>
>
> Generated by `MeetBot`_ 0.1.4
>
> .. _`MeetBot`: http://wiki.debian.org/MeetBot
>
>
https://meetbot.fedoraproject.org/fedora-meeting/2015-07-20/fedora_docs.2...
>
> --
8 years, 8 months
Applying for membership in this group
by Primoz D.
Hello,
My name is Primož, I'm 34 years old and reside in Slovenia, EU. I have a
bachelor's degree in "Civil Engineering" (named differently here, but I was
told that that is probably the most appropriate expression in English) and
am currently unemployed. As far as my Linux experience goes, it is at
novice level currently, even though my first clash with Linux was back in
the late 90s when I installed Slackware on my computer, but back then, my
main interest was mostly IRC, using BitchX, and wasting absurd amounts of
time playing a MUD. After that, it was mostly Windows usage until a user on
Freenode suggested Fedora to me, which I did install and tried out for a
bit, but having to switch to Windows occasionally, the usage of Fedora
dwindled down until I had to do a full Windows reinstall due to hard drive
failure and never gotten around to installing Fedora alongside Windows
again. A week or so ago, I managed to utilize my sister's laptop for
testing purposes, and, after removing the obsolete Windows XP installation
on it, installed Fedora 22 Workstation i386 and am now using the laptop and
the OS for simple router usage, as well as learning about basic networking
and various options that come along with that. Since I'm currently
unemployed, the spare time amount is usually quite substantial, and after
another user on Freenode in #fedora pointed me to making a Fedoraproject
account to be able to "fix" a typo on a wiki page, I decided that I'll try
and give something back, because just by running Fedora on the laptop
enabled me to actually connect to the Internet at all, since Windows
doesn't want to recognize my USB modem for some reason, and that alone is
worth enough for me to return the "favor" back in any way I can. As far as
English language knowledge goes, written (typed), grammar and spelling wise
isn't really a problem for me, I consider myself fluent in the language,
owing that to a big number of English books I've read since my late
elementary school years. I'm not really sure how much activity is
expected/required from someone new joining the Docs project/new wiki
gardeners, but I'll try to do my best if I'm accepted and hopefully I can
contribute to something else to Fedoraproject in the future.
That's about it as far as basic introduction goes, if you have any other
questions while considering the application, don't hesitate to drop me a
line (wall).
Until next time, if not sooner, Primož
8 years, 8 months
Fedora Docs Workflow and Publishing Improvement Project
by Brian Exelbierd
I talked with randomuser about strategy moving forward. I have written up our conversation in an interview style. The primary goal is to start some conversation around these topics. Therefore:
YOUR HOMEWORK: Send an email back with the questions this raised for you
Our ulterior motive is to further inform our presentation at Flock.
---
To understand where we are going, we have to know where that is.
*What is the goal of the docs group and docs.fedoraproject.org?*
The docs group as having two basic, related goals: assisting developers, and assisting users. Our current strategy does a reasonably thorough job of assisting users, but we don't do as well with assisting developers, or new docs contributors, for that matter. There's lots of new crazy code out there, and the large book strategy has a lot of inertia and can feel stifling when it comes to new additions and rapidly changing areas.
*How do we fix this?*
The high-level solution is to enable developers and experienced users to write about whatever they like to do. We would use a workflow that leverages the Docs Team's greatest strength, experience. People can work with seasoned writers to produce very high-quality work.
The biggest problem Docs contributors have is finding something to do, so that workflow should provide a pipeline of requests working through clearly defined steps. a request could be from a user ie https://bugzilla.redhat.com/show_bug.cgi?id=1229560 or from a developer, ie the API reference discussion, or internally generated by the docs team as a need for an upcoming release. The focus of this process should be on the quality of content and the efficacy of addressing a specifically defined topic. Someone shouldn't have to worry too much about markup or tools unless they've specifically opted to work in a markup or with the tools.
This goes beyond just telling people, "You can write whatever you want however you want and get help with the publishing." That's not enough. The scope of our books is really too big to facilitate focused topical writing. The cookbook is evidence of that; Randomuser has offered cookbook assistance to many people and few take the bait. The new strategy is to build publishing/site generation tooling that supports varied content. This way contributors can range from independently capable writers, to SMEs looking to share but not learn the specifics of publishing, to requesters, to those wanting to write but needing assistance to get there.
Ideally, we reach a point where each specialty group/SIG has a set of articles covering their interests, in a format that they're able to maintain. The only real example of that we have is the Amateur Radio Guide. And this is is basically single-handedly maintained by jjmcd, despite there being many other Fedora contributors doing radio stuff. This isn't ideal, but it is working for today. Rather than try to fix a working process, let's try to get more folks on-board, for example the Astronomy SIG.
*How are we going to implement the solution?*
Implementation is a challenge. There are two aspects, **Community** and **Tooling**.
On the community side, We don't have a well conceived plan (other than sharing and organic growth - which is slow and not guaranteed). This is critical as tools are not valuable if no one uses them. We can't grow our docs if maintenance consumes all of the folks involved.
With regards to tooling, we have lots of bright people and lots of ideas around tooling. Tooling is solvable and being worked on. You can contribute to and follow the progress at https://github.com/immanetize/anerist . But beforewarned, it could be be better described.
*How do you envision the workflow for a new content change/addition?*
The system consists of a bunch of restricted commit repos containing large guides, collections of ReST articles, whatever. When a change is committed to a repo the tooling will see the commit and attempt to generate html from the affected files. If that succeeds, (and hopefully if it passes some validation tests, the strings in Zanata (Internationalization Tool) will be automatically updated to make the work available for translation immediately. The tooling will also extract some metadata from the document (title, subtitle, abstract, categorical information, etc.) and ultimately use that to generate a stage version of the docs site for verification before publication.
An individual contribution comes in via a pull request workflow. This could be via a pagure.io solution or via a traditional git clone solution. Pagure.io has the benefit of bringing the fork/edit/PR process into a web-based format perfect for many contributors and for drive-by contributors. The merge starts the process just mentioned.
Ideally we can support acls on a per branch and repository basis. This way a SIG, for example, could have control of their specific documentation by merging PRs. Members of the docs-writers group would have global commit capability. The branch structure can resemble many popular open source projects with a master that is clean and release branches for future maintenance. The system is branch-aware, so everything from 'master' goes to a draft area, things in f$n gets labeled as appropriate for f$n.
*What are our big blockers today?*
1. Community Outreach and Growth Plan.
2. Website redesign for docs.fedoraproject.org - it is stalled on some decisions around older docs, etc.
3. Publishing is stalled on both design and the need to integrate legacy tools such as publican in a new paradigm with other formats that use other tools. These need to all roll to a common docs listing/Table of Contents.
8 years, 8 months
Fedora Docs Project Meeting Minutes 13 Jul 2015
by Petr Kovar
====================================================================================================
#fedora-meeting: Docs Project Meeting - Agenda: https://fedoraproject.org/wiki/Docs_Project_meetings
====================================================================================================
Meeting started by pkovar at 14:10:31 UTC. The full logs are available
at
http://meetbot.fedoraproject.org/fedora-meeting/2015-07-13/fedora_docs.20...
.
Meeting summary
---------------
* Roll Call (pkovar, 14:10:51)
* New Writer Check-in (pkovar, 14:13:17)
* Publishing (pkovar, 14:16:36)
* https://github.com/fedora-cloud is already on github (bexelbie,
14:25:07)
* ACTION: bexelbie will look further into CentOS' GSoC efforts around
a doc toolchain (bexelbie, 14:31:59)
* ACTION: bexelbie will look further into CentOS' GSoC efforts around
a doc toolchain (bexelbie, 14:36:13)
* ACTION: bexelbie will look further into CentOS' GSoC efforts around
a doc toolchain (bex, 14:37:20)
* Guide Status (pkovar, 14:41:00)
* https://github.com/fedora-cloud is already on github (bexelbie,
14:41:03)
* Open Floor (pkovar, 14:48:31)
Meeting ended at 14:53:10 UTC.
Action Items
------------
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
Action Items, by person
-----------------------
* bex
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* bexelbie will look further into CentOS' GSoC efforts around a doc
toolchain
* **UNASSIGNED**
* (none)
People Present (lines said)
---------------------------
* bexelbie (64)
* pkovar (43)
* smccann (16)
* lnovich (16)
* wdashley (9)
* zodbot (8)
* pbokoc (5)
* haraldh (2)
* kirsti1 (1)
* Southern_Gentlem (1)
* bex (1)
* dgilmore (1)
Generated by `MeetBot`_ 0.1.4
.. _`MeetBot`: http://wiki.debian.org/MeetBot
8 years, 8 months
Getting Started Docker/Container Guide
by Glen Rundblom
Hello,
So I was pretty excited to use docker, and thought it would be a good
thing to make a getting started guide for docker and linux containers
but, Docker's online documentation is excellent. I am not sure if it
would be a good thing to make a guide that might be obsoleted quickly
when such a good support resource exists.
Thoughts?
Thank you,
-Glen
8 years, 8 months