docs March 2016

docs@lists.stg.fedoraproject.org

21 participants
32 discussions

Orphaning FreeIPA guide
by Martin Kosek 11 Aug '16

11 Aug '16

Hello all, FreeIPA project is already for some time without sufficient resources to revive and maintain our former long upstream user guide. We did not find enough manpower either in FreeIPA developer nor our users community, so we decided to stop maintaining it. Detailed justification including links to mail threads in: http://www.freeipa.org/page/Upstream_User_Guide I would like to avoid leaving any loose ends on Fedora Documentation project side, do you have any recommendation for us? I already closed respective Bugzillas and upstream Trac tickets with explanation. Should we also orphan the guide in https://fedoraproject.org/wiki/Docs_Project_meetings#Guides or on any other locations? For starters, I think we should close the "freeipa-guide" component of "Fedora Documentation" as nobody from our team would be responding there. Thanks for any advise. -- Martin Kosek <mkosek(a)redhat.com> Supervisor, Software Engineering - Identity Management Team Red Hat Inc.

5 10

introduction - Ryan
by Ryan Gough 27 May '16

27 May '16

Hi Everyone, I'm looking at getting involved in the project as I have been a long time user of Fedora (e.g. since Core 1) and would like to start contributing. My name is Ryan, I'm from Western Australia (GMT+8). I am an IT technician and have been using linux as a hobby since 2k4 (using RH9). I have also had the opportunity to work with RHEL in my job during a project as well as having worked with a couple of other distros. In my line of work I have often needed to produce documentation to a professional standard and I feel I can contribute this way currently. I believe I should be able to contribute 4 hours a week at this point in time. Regards, Ryan irc: _terminal_ FAS: t3rm1n4l

2 2

Re: Fedora website & docs site feedback
by Brian Exelbierd 05 May '16

05 May '16

+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-Firewalls... > > (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_Firewall.... > > (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.htm... > > (click link, it's fedora 20 doc) > > link 6: > 16.7. Firewall Configuration - Fedora Documentation > docs.fedoraproject.org/.../Fedora/.../s1-redhat-config-kickstart-firewall.ht... > > (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-Conf…, > 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-Conf…, > 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/AccountSyst…, > 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

3 2

Fedora 24 Release Notes
by Pete Travis 31 Mar '16

31 Mar '16

Hi all, We're well into the validation portion of the F24 release cycle. The Alpha release is out, freezes are in place, and we have release notes to write. Contribution to the release notes is coordinated via the wiki, at https://fedoraproject.org/wiki/Category:Documentation_beats . The table there shows folks that have volunteered to investigate, and write about, changes within some defined scopes. If there's an asterisk next to a name, it's because that person has not validated their participation for this cycle yet, and the 'beat' is effectively unclaimed. While we refer to 'beat assignment', it's really just a coordination tool. You can write about any topic of interest, even if there's already a name down; the table simply tells you who to coordinate with. Look at package changelogs, packaged documentation, upstream release notes, the Change process at https://fedoraproject.org/wiki/Releases/24/ChangeSet , upstream docs, etc to find information about a given topic. You *do* need to find topics within a given beat through some investigation; visit #fedora-docs or mail the list if you're having trouble getting started. There are some major areas we should prioritize. Foremost, adequate coverage of the three primary deliverables, Cloud, Server, and Workstation. There are some Changes in play for each, but we should also coordinate with the working groups for these deliverables, and do some independent investigation. It is also important to review *all* the Changes, and communicate with those change owners as needed. An entry in the release notes should: - Say what the thing is - Explain what the thing does - Give the reader an idea of why they might use the thing, or what problem it would solve for them. - Excite the reader about the new features of the thing - Warn the reader about things they might need to do, if they used the old version of the thing and it has changed. The table isn't structured this way, but you might also think of the beats in terms of SIGs; there's a Python SIG, Java SIG, virt folks, kernel folks, and so on. You could liason with these groups and get the scoop on their work. Our schedule is at https://fedorapeople.org/groups/schedule/f-24/f-24-docs-tasks.html . We are behind schedule. Edits to the wiki seem light, so I propose we hold off on closing the wiki for a couple weeks and aim to have the content ported to docbook and published to coordinate with the Beta release. -- Pete

1 0

Proposal of updating " Fedora Documentation "Welcome" "
by Ooyama Yosiyuki 31 Mar '16

31 Mar '16

At the website of https://docs.fedoraproject.org/en-US/index.html , at the section "Links to other parts of the Fedora Project site" , There is the link phrase " Get Fedora: http://fedoraproject.org/get-fedora.html " , but it is redirected to https://getfedora.org/ . so this link phrase shoud be change to " Get Fedora: https://getfedora.org/ " ? similarly " Fedora Documentation Project schedule: http://fedoraproject.org/wiki/DocsProject/Schedule " is redirected to " https://fedoraproject.org/wiki/Docs_Project_schedule " .

1 0

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

30 Mar '16

Dear all, You are kindly invited to the meeting: Docs Office Hours ( Americas ) on 2016-03-31 from 12:00:00 to 13:00:00 US/Mountain 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. Source: https://apps.fedoraproject.org/calendar/meeting/434/

1 0

Fedora 24 release notes
by Glen Rundblom 28 Mar '16

28 Mar '16

Hello everyone. I know I haven't been able to attend the meetings lately, but I haven't seen any beat assignments for the Fedora 24 release notes. Is there a new place this is being kept track of? Thanks! -Glen

5 7

[Fedocal] Reminder meeting : Fedora Docs Weekly Meeting
by Pete Travis 27 Mar '16

27 Mar '16

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2016-03-28 from 14:00:00 to 15:00:00 UTC At fedora-meeting(a)irc.freenode.net The meeting will be about: An hour of docs folks talking about what they are working on and what they'd like to work on. More information available at: [https://fedoraproject.org/wiki/Docs_Project_meetings](https://fedoraproject… Source: https://apps.fedoraproject.org/calendar/meeting/371/

1 0

Interested in doing GSoC in Anerist project
by Tummala Dhanvi 25 Mar '16

25 Mar '16

Hello everyone, * I am interested in doing Google Summer of Code in Anerist[0], I apologize for the delay in completing the proposal as I was into other errands. * You can find my proposal here[1], feel free to make me any suggestions. I will be sending the mentors the same to mentors in person asking for review. [0]https://fedoraproject.org/wiki/Summer_coding_ideas_for_2016#Anerist [1]https://fedoraproject.org/wiki/GSOC_2016/Student_Application_dhanvi -- Regards Tummala Dhanvi https://www.dhanvi.org "Only thing that can never be 'RE-CYCLED' is 'WASTED TIME' ".

1 0

Push fr release-notes for f23 in stg
by Jean-Baptiste 24 Mar '16

24 Mar '16

Hi there, Better late than never, can you please push french translation of f23 release-notes in staging ? (and give the link) We took this doc to rebuild our team, processes and take Zanata in hand. It was a good candidate because it has every kind of string to translate, some are use for website too. I assume we should be ready to address f24 release-notes (april 13th to april 18th for beta release notes translation, if I correcty read the schedule). Note : there were some useless strings coming from f22 release notes and f21 release notes. Strange, but useless to fix now. I'll have a close look at f24 release notes to prevent this. Thanks for your help. -- Jean-Baptiste Holcroft

2 3

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 March 2016