docs August 2018

docs@lists.fedoraproject.org

13 participants
19 discussions

Re-factor Installation guide
by Sheogorath 03 Sep '18

03 Sep '18

Hi, I checked our installation guide today and was a bit surprised/disappointed. What I expected was a step by step guide (like a getting started) and found a very detailed and over-complicated installation guide that goes into a lot of detailed options of anaconda options that (using and installing Fedora on various machines for a while now) basically never needed. I think it's good to have all these options explained, but I think that it's probably easier to move these option explanations to sub-pages instead of having them in the main document, which I would expect to be very straight forward. Also, when I click the link to the installation guide on the download page on https://getfedora.org the first thing that greets me is a explanation, that this is the guide about how to install Fedora and that it can be automated, etc. followed by a bunch of legal information, end of page. That's pretty much everything but helpful when someone wants to install Fedora Workstation on their machine. I'm willing to compose a (hopefully) more straight forward installation guide, if there isn't someone else who already does that. Basic idea: Just getting through a installation with an empty disk and document this with screenshots. Along with that adding some descriptions, which should help these pictures. Starting by the boot process to the User login. An external, linked, document should also provide guidance for Fedora Media Writer, if this guide doesn't already exists (the basics exist but Windows as well as Linux are mixed on one page, and this doesn't seem to be much sense to me from an end user perspective. Should may be split into two documents as well) So what do you think? Agreement, disagreement? Critics are welcome :) -- Signed Sheogorath

4 3

[Fedocal] Reminder meeting : Fedora Docs Weekly Meeting
by bex＠fedoraproject.org 28 Aug '18

28 Aug '18

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2018-08-29 from 15:30:00 to 16: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/9196/

1 0

[Fedocal] Reminder meeting : Docs Writing Hour
by bex＠fedoraproject.org 27 Aug '18

27 Aug '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-08-29 from 10:00:00 to 11:00:00 US/Eastern The meeting will be about: Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content. There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week. Source: https://apps.fedoraproject.org/calendar/meeting/9195/

1 0

Re: Can you help me out with integrating editing to the docs It will take you 8,77 minutes to follow.
by Adam Samalik 24 Aug '18

24 Aug '18

Hi Leslie, I really value your work and I'd really like to help you to integrate it. But rather than doing the integration work myself (for which, to be fair, I don't have many spare cycles), I'd like to teach you how to do it yourself. The benefits would be: * The integration of your work wouldn't generate additional work for other people, other than the actual review + feedback * You would be able to get feedback in the PR itself — there is a space for discussion, as well as posting inline comments * Many different people could help with commenting, reviewing, and even merging the changes * You would get credit as those changes would be clearly marked as yours I'd rather spent an hour teaching you how to do future changes yourself, rather than doing it myself for 8.77 minutes. Especially with the amount of work you do, I wouldn't be able to keep up long-term. Also, there are many other people out there that could help to review the changes. I know, git might be a new tool for many writers, and learning it might require some effort, but using it has many benefits for large communities such as Fedora, where we need to scale our work between many people living in different parts of the world and different timezones. If we want to work in a large community, or want to build a large community, we need to have workflows that scale. And git is one of the least horrible options there. So, I'm happy to have a video call with you, even for an hour, going through the integration of your changes, so you feel comfortable doing them yourself next time. Would that work for you? Please let me know. regards, Adam On Mon, Aug 20, 2018 at 5:43 PM Leslie S Satenstein <lsatenstein(a)yahoo.com> wrote: > Hi Adam, > > *Your response will go a long way to understanding what I mean and do by > "editing"* > > Can you help me out with integrating editing to the *.adocs? > > What I have attached is one fairly short libreoffice writer document (1.5 > pages) and the corresponding updated Desktop.adoc. > > Before I can generate a pull request, I made a correction and asked some > questions inside the libreoffice writer file. Those questions, if properly > responded to, are to be the modifications to be made to the corresponding > *.adoc file. A third x.sh file just invokes vim against the location to > where the target adoc file resides. > > I am and attaching a zip file with the updated Desktop.adoc and the > corresponding libreoffice "Desktop.adoc.odt". The way I see things > working, the libreoffice document is the working document. When it is > clean, the contents therein are what is transfered to the corresponding > *.adoc file and a PR sent. > > > 2) Can you please note. Not all document writers are git users. They are > writers, and can follow instructions. Please add a definition of a Pull > Request. > > Pull Request: A formal request document, transmitted to the owner of the > git repository. The PR contains revisions or insertions that you are > requesting for that git repository. > > > Regards > > > * Leslie* > *Leslie Satenstein* > *Montréal Québec, Canada* > > -- Adam Šamalík --------------------------- Software Engineer Red Hat

3 5

CoreOS, Silverblue, Containers docs repositories are up
by Sanja Bonic 21 Aug '18

21 Aug '18

Hi everyone, The docs repositories for CoreOS, Silverblue, and container tooling are now set up (links below). I used the template repository that Adam linked in a previous email. Thanks for that! More content will be added this week. This was just an initial commit. https://pagure.io/fedora-docs/containers https://pagure.io/fedora-docs/coreos https://pagure.io/fedora-docs/silverblue The local building didn't work because of errors that I'll verify another time (with regards to whether it's because of the code or my current system). How do we go about integrating them as sections in the current Fedora documentation? The goal is to publish some of the current really good documentation we have (like Chris Negus' Kubernetes on Fedora guide, container guide in general, etc.), and to be able to tell people where to go in order to get informed. With the integration into Fedora docs we now don't have to worry about infrastructure and formatting anymore, which is really nice. Thanks, Sanja

4 11

[Fedocal] Reminder meeting : Fedora Docs Weekly Meeting
by bex＠fedoraproject.org 21 Aug '18

21 Aug '18

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2018-08-22 from 15:30:00 to 16: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/9196/

1 0

How to correctly cross-link between FDocs pages in Antora?
by Justin W. Flory 20 Aug '18

20 Aug '18

Hi all, In the switch to Antora, a cross-linked reference to another document broke; I wanted to know what the correct way of cross-linking other documents in the same Pagure repository for a Fedora Docs project is. The link that broke is found here: https://docs.fedoraproject.org/en-US/commops/contribute/join/#first-steps https://pagure.io/fedora-commops/blob/master/f/docs/modules/ROOT/pages/cont… It seems to use the Antora xref syntax, but I wasn't sure why the cross-reference doesn't render correctly in production. Thanks! PS — Finally switched over all of our wiki pages today to point to Fedora Docs. Super excited to finally do this, thanks for the hard work everyone!!! -- Cheers, Justin W. Flory jflory7(a)gmail.com

4 3

[Fedocal] Reminder meeting : Docs Writing Hour
by bex＠fedoraproject.org 20 Aug '18

20 Aug '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-08-22 from 10:00:00 to 11:00:00 US/Eastern The meeting will be about: Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content. There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week. Source: https://apps.fedoraproject.org/calendar/meeting/9195/

1 0

server documentation (APACHE) The_Apache_HTTP_Server.adoc
by Leslie S Satenstein 15 Aug '18

15 Aug '18

The documentation for Fedora 28 is based on the Fedora 19 release. Is there someone who can edit "The_Apache_HTTP_Server.adoc" and bring that document up-to-date. I am editing the grammar, but it would be helpful (timewise) to start grammar checking with an update Regards Leslie Leslie Satenstein Montréal Québec, Canada

2 1

[Fedocal] Reminder meeting : Docs Writing Hour
by bex＠fedoraproject.org 15 Aug '18

15 Aug '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-08-08 from 10:00:00 to 11:00:00 US/Eastern The meeting will be about: Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content. There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week. Source: https://apps.fedoraproject.org/calendar/meeting/9195/

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 August 2018