Docs Fad 2016
by Pete Travis
Hey everybody, let's do a FAD!
We've had a lot of discussions about workflow, tooling, writing
strategies, and shed paint since the last FAD, but our situation wrt
publishing has not changed. It's time that we get together, find a
room, and lock the door until a solution presents itself.
To that end, our friend shaunm has arranged for space at Red Hat Tower
in Raleigh over the first weekend in May. Shaun has thoughtfully
*also* invided other Docs folks from the Fedora ecosystem; this FAD[1]
will give Fedora, CentOS, and Red Hat writers an opportunity to compare
notes, workflows, etc with the goal of combining efforts and sharing
content effectively.
The agenda still needs work, but I think our recent list discussions
frame the intent nicely. We need to make room for modularized content,
and doing so enables both contribution and consumption.
If you can provide a strong contribution towards solving this problem,
please consider attending the FAD. Visit the wiki page, put your name
on the list, and make sure to hit the table in the Budget section if
you need funding. If you can't make it, we may be able to set up
remote participation, or you can at least add your thoughts to the
gestalt via the agenda or list.
-- Pete Travis
Fedora Docs Project Lead
[1] https://fedoraproject.org/wiki/FAD_Documentation_2016
7 years, 11 months
Re: Fedora website & docs site feedback
by Brian Exelbierd
+Fedora-docs list
Ian,
Your experience is a lot of the motivation behind the work the fedora-docs folks are doing to fix onboarding, editing, and building of docs. Unfortunately it is slow work, but it is important. If you'd like to help, please join us on the docs list (docs(a)lists.fedoraproject.org) and at our IRC meetings on Mondays from 14:00:00 to 15:00:00 UTC at fedora-meeting(a)irc.freenode.net .
regards,
bex
> On Aug 31, 2015, at 4:37 AM, Ian Kelling <ian(a)iankelling.org> wrote:
>
> I've tried fedora a few times over the years. I recently met Remy
> (fedora community lead) at oscon and he convinced me to give it
> another try and give some feedback. This is meant to be constructive,
> just my impression, I could be missing things.
>
> I google "fedora firewall", because I'd like to learn generally about
> it, how to do a few common things like opening a port, or forwarding
> something. I see links to official fedora docs. So I think, yes, lets
> rtfm!
>
> link 2:
> 2.8.2. Basic Firewall Configuration - Fedora Documentation
> https://docs.fedoraproject.org/.../Fedora/.../sect-Security_Guide-Firewal....
>
> (click link, it's fedora 11 doc)
>
> link 3:
> 3.8.13. Configuring the Firewall - Fedora Documentation
> https://docs.fedoraproject.org/.../Fedora/.../sec-Configuring_the_Firewal....
>
> (click link, it's fedora 19 doc)
>
> link 4:
> 3.8.9. Disabling firewalld - Fedora Documentation
> https://docs.fedoraproject.org/en.../Fedora/.../sec-Disabling_firewalld.h....
>
> (click link, it's fedora 20 doc)
>
> link 6:
> 16.7. Firewall Configuration - Fedora Documentation
> docs.fedoraproject.org/.../Fedora/.../s1-redhat-config-kickstart-firewall....
>
> (click link, its fedora 20 doc)
>
> So... now I really want to know if fedora 22 doc has a section on
> firewall.
>
> I see the url's all look like this:
> https://docs.fedoraproject.org/en-US/Fedora/19/html/Security_Guide/sec-Co...,
> so I try changing the 19 to 22, but it takes me to
> https://docs.fedoraproject.org/en-US/index.html.
>
> So then I look for a search feature. I don't see one. So then I expand
> the fedora 22 drop down, and I see 7 high level categories with no
> obvious right place, so now I'm fairly confused as to how to find
> stuff.
>
> So I search firewall on google
> site:https://docs.fedoraproject.org/en-US/Fedora/22. And the closest
> thing I see is the #1 link, 14.15. Configure the Firewall to Allow
> Incoming NTP Packets. But I'm wondering if there is a general section
> like link 2 or link 3 from the original google search, so I click around
> some more, I figure there are 4 of the 7 sections in the sidebar which
> could cover firewall: installation guide, networking guide, selinux
> users and administrators guide, and system administrators guide. So I
> click on administrators guide, (and I'm slightly surprised to find a
> comprehensive table of contents, as the ui design of left menu sort of
> implied that it was THE table of contents, not that there was more
> useful list of sections within. Why couldn't I see those things in the
> expandable menu?). I do a word search, find the ntp related link I saw
> before, repeat for the other 3 sections, find one in the installation
> section which looks generic, only learn that installation has a limited
> set of firewall configuration options and this is not what I'm looking
> for. So I'm deciding there is no general firewall documentation for 22.
>
> So now I look back at the best link I originally found,
> https://docs.fedoraproject.org/en-US/Fedora/19/html/Security_Guide/sec-Co...,
> and I think, yes, I'm confirming my original impression that this is
> really the kind of documentation I was looking for, but I'm really
> confused and frustrated: does any of this still apply? did they abandon
> firewall-config? What's the story?
>
> I've had this same experience several times with fedora, and at this
> point I've mostly given up frustrated and annoyed.
>
> Once, when I was feeling a bit more ambitious, I thought. Hmm, maybe I
> can help out on docs, cuz I have noticed the new links like "click to
> contribute to fedora!" So click through, quickly get to this page:
>
> https://fedoraproject.org/wiki/Join_the_Docs_Project
>
> Well, after 15 minutes of reading lots of stuff I'm not interested in, I
> can't find the source code to the fedora 22 official docs, or anything
> about how to improve them, and I think, I'd have gotten way more done
> by just going to the arch wiki firewall page, and I could have just hit
> edit and improved the thing.
>
> Suggestions: make previous fedora version documentation link to the
> relevant current documentation because google links to old docs are the
> reality for most fedora searches, or if there is no newer, say that, and
> say whether this is still relevant to newer distros. And port
> documentation forward, it seems there is lots of good documentation
> sections which only exist for older fedora versions. Make contributing
> to the official docs possible in some short amount of time. Make a
> search feature (this is 2015), even if it's just to some 3rd party
> search engine (google site search gave me good results).
>
> Oh, and how about filing a bug? First google link: "How to file a bug
> report - FedoraProject"
> https://fedoraproject.org/wiki/How_to_file_a_bug_report It's like a
> horribly bad novel when I wanted a tldr for any reader who's filed bugs
> before for free software projects and wants to file one for fedora:
>
> Up top, "Documentation Summary:", doesn't try whatsoever to summarize
> "how to file a bug report", but just talks about meta things about the
> document, complete waste of my time.
>
> 1st section after the fake summary: "How to File a Bug Report", first
> sentence: "This page describes a procedure for reporting software bugs
> to Fedora developers." Well, I'm not a fedora developer, so this isn't
> for me? Well, I don't see any other way to file a bug sooo, does fedora
> accept bug reports from it's users? And it's redundant, making it just
> bad quality writing, leaving a bad impression, and making me think no
> one actually reads or improves this page. Significant chunk of new users
> are giving up at this
>
> Ok, this is a wiki, so let's try and edit this page. Click log in, which
> leads to this page this page:
> https://fedoraproject.org/wiki/Account_System?rd=Infrastructure/AccountSy...,
> which is a novel length page which as far as I can see does not actually
> lead to getting a wiki account! No wonder no one edited the page,
> creating a wiki account if a total nightmare! Suggestion: fix that.
>
> Ok, flash back to the filing a bug wiki page. Next sentence: 'A bug is
> defined as "an error, flaw"'..., am I doing a homework assigment? This
> document is called "how to file a bug report", not spend an hour reading
> wikipedia. Ok, next sentence says this is about
> https://bugzilla.redhat.com/, let's skip to the chase and try using
> that, because the rest of this document looks pretty useless.
>
> Go there, and see from the 1st sentence.: "Thank you for visiting Red
> Hat Bugzilla. Red Hat Bugzilla is the Red Hat bug-tracking system and is
> used to submit and review defects that have been found in Red Hat
> distributions." Ok, so am I at the wrong place? This is confusing. Is
> fedora a "a red hat distribution"? I skim
> a bit more... "If you are a Fedora Project user and require assistance,
> please consider using one of the mailing lists we host for the Fedora
> Project. " Well, I'm filing a bug to get "assistance" in it being fixed,
> so it seems I should post it on the mailing list instead?
>
> So, wondering if fedora is a red hat distribution, I remember that there
> is a link on the main fedora page "Learn more about the relationship
> between Red Hat and Fedora »." So I go there. It's not very helpful, its
> not well written to stand on it's own. The first section goes like this
> "jill makes pizza for anyone. John makes pizza for big companies. People
> go to jill in order to collaborate with john. Businesses love john's
> pizza. The end. (notice a gaping hole? Why would someone go to john in
> order to collaborate with jill? And tt's pretty relevant title of the
> page.). Anyways, this one is a minor gripe compared to the rest, but my
> suggestion is to replace it with a higher quality fedora domain page,
> which includes a link to the red hat page.
> --
> websites mailing list
> websites(a)lists.fedoraproject.org
> https://admin.fedoraproject.org/mailman/listinfo/websites
7 years, 11 months
L10N|DOCS Make the work of translator teams easier
by Jean-Baptiste
Hi there,
The French translation team had issues with translating documentation.
We didn't know what is up to date and need to be translated, nor could
have an overview of work-in-progress translation.
José (jaaf64) created two pages :
* a [how-to] that explains the production of translated documentation
from translated po files (this allows reviewers to see the translated
messages in their final context)
* a [tracker] to help coordination and information exchange between
doc team and translation team.
The tracker is the most important piece. It aims at sharing :
* information about what is up to date and what is not,
* guide translation priorities
* explanation about why things are read-only
* Zanata direct links to projects
* project specific guidance from owners toward translators
If some docs/trans contributors are available, we would like to take the
opportunity to discuss this at Flock Krakow this summer.
Would you please help us by giving your feedback and telling us if you
agree to use this canvas for make our collaboration easier ?
Thanks by advance,
[how-to]
https://fedoraproject.org/wiki/L10N/how_to_build_a_translated_book_from_t...
[tracker]
https://fedoraproject.org/wiki/L10N_Translation_State_of_Guides_on_Zanata
--
Jean-Baptiste Holcroft
7 years, 11 months
Introduction Email
by Drew Meigs
Hi, everyone.
My name is Drew and I would like to join the "Docs Project." I am from
the US/Eastern time zone (UTC -4 currently). I am relatively new to
Fedora, but I have been using Linux for somewhere around 10 years
(mostly Debian-based systems until recently). I feel I would be a good
fit with the community because my passions are teaching people, and
technology. I feel like this group combines the best of both worlds.
My main interests are going to be proofreading/correcting and testing
for accuracy or doing some QA on the documentation. Eventually I would
like to write documentation of my own, but I feel like it could be a
while before I am ready to do something like that. I would like to
collaborate on projects in the interim, maybe. Though these are the
things I WANT to do, I am willing to do most things that the Docs
Project takes care of. I am a pretty easy-going guy and if I am asked to
do something, I will generally do it. I should be able to dedicate a few
hours each week to projects. Some weeks, I may be able to do more.
Though I do not have any real, notable experience with documentation, I
always got good grades on my papers in college, and friends would get me
to proofread for them. I do have experience in explaining things at the
level of a beginner end-user, though, and I feel that could translate
over to the documentations with a bit of work. My skills are more on the
social side than the technical side (though I wouldn't consider myself
to be too green on technical things). What I mean to say is that I do
well with people and can generally identify and empathize with my target
audience.
It is very nice to be here and I look forward to meeting and working
with you all. If you see me on IRC (rmeigs), feel free to say hi.
Drew
My GPG Key Fingerprint:
pub 4096R/24E57F48 2016-04-24
Key fingerprint = 31BD B8C4 8FFF FAF5 303F C680 6BF1 A414 24E5 7F48
uid Drew Meigs <dmeigs[at]openmailbox.org>
sub 4096R/F652FFD6 2016-04-24
7 years, 11 months
