docs June 2018

docs@lists.fedoraproject.org

8 participants
14 discussions

Antora for Docs: making sure our contributors are on board
by Adam Samalik 15 Aug '18

15 Aug '18

As many of you have probably noticed, together with bex and few other people I work on moving the Fedora Docs to Antora. It has many technical benefits as well as an active community. Talking about community, I want to make sure that when the time comes and we're ready to push this thing to production, our contributors are on board. So I've just created a new epic: People! [1] "The main reason we go through all this trouble is people. We want to make it simple for people to contribute to the docs. And might not be a bad idea to make sure our contributors are on board when we go crazy and push this thing to production." I'm looking for any useful input about making sure our contributors are on board. I want this to be as smooth as possible. My thinking is: * Announce it here on this very list. * Contact in advance every group having their docs on the site and: ** making sure we have converted their asciibinder source into the Antora source right ** making sure they know how to make changes * Do this over a few days, switching the Antora branches in all repositories the site is built from to be the main branches. During these few days, the current asciibinder site wouldn't update. All updates from this period would end up on the new site. Basically, doing a few-days-log freeze. How does that sound? Anything I've missed? Thanks! Adam [1] https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/epic/58 -- Adam Šamalík --------------------------- Software Engineer Red Hat

5 9

How to just report/fix one mistake on the wiki?
by Matt McCutchen 13 Jul '18

13 Jul '18

Dear docs team, I found a mistake on the wiki (Fedora 28 needs to be added to https://fedoraproject.org/wiki/Common_bugs) and wanted to report or fix it, but it looks like to fix it, I now need one non-CLA group. The Docs group looked the most likely for this scenario, but based on https://fedoraproject.org/wiki/Join_the_Docs_Project , it looks like you expect an introduction and ongoing involvement, which I'm not willing to commit to. https://fedoraproject.org/wiki/Reporting_problems_with_Docs#I_found_a_probl… didn't give me any help either. Is there a process for people who just want to report or fix one mistake on the wiki? Have I missed a previous discussion of this? Or should I pose the question elsewhere? I didn't find anything useful here: https://www.google.com/search?q=what+group+to+join+if+I+just+want+to+contri… https://lists.fedoraproject.org/archives/search?q=contribute+to+wiki https://lists.fedoraproject.org/archives/search?q=contribute+to+wiki+group If you are willing to count this as my introduction and grant me access (FAS mattmccutchen) without an expectation of ongoing involvement, I will be happy to update the relevant places on the wiki. I've been using Fedora for 13 years and have a modest history of useful wiki contributions from before the restriction was introduced, though I've never been involved deeply enough with anything to join a non-CLA group: https://fedoraproject.org/w/index.php?title=Special%3AContributions&contrib… However, my question stands what new users should do. Thanks for your attention! Matt

2 3

Self-Introduction: Noel Casimiro
by Noel Salvador Casimiro 01 Jul '18

01 Jul '18

Hi, I'm Noel Casimiro from the Philippines. I currently work as a librarian in a university. I've been a Linux user since 2009 but this is my first time on intending to join an open source software project since I'm confident that I already acquired the necessary skills to contribute. My computer skill level is intermediate because I can successfully install and configure a Linux and Windows OS. However, I can only do basic web development/programming using HTML/CSS, PHP, and MySQL but I plan to learn Javascript, Python, and R. The only thing that I can immediately contribute significantly to the Fedora project is user documentation especially about installation and configuration in a desktop or laptop. This link: http://article.gmane.org/gmane.linux.redhat.fedora.advisory-board/1475/ in this wiki page: https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle prompted me to join Fedora and attempt to let you know that the link is not working. Furthermore, it seems that the instructions in this link: https://fedoraproject.org/wiki/Creating_GPG_Keys#Creating_GPG_Keys_Using_th… does not reflect the current version of Seahorse 3.20 since I cannot find the PGP Key option. I created a GPG Key using the command line instead. Hopefully, I can edit and improve wiki entries in the future. If time permits, I would also like to do documentation translations in Filipino (Tagalog) to help increase the number of Fedora users in my country (my time zone is GMT+8 Asia/Manila). I am looking forward to collaborating with the Docs group to improve Fedora, Linux, and the entire open source ecosystem. Cheers, Noel -- pub rsa2048 2018-06-28 [SC] [expires: 2020-06-27] F62C 354A 5C65 916E 7BDE 2724 B914 7B4E B939 2E07 uid [ultimate] Noel Casimiro <nsbcasimiro(a)gmail.com> sub rsa2048 2018-06-28 [E] [expires: 2020-06-27]

3 2

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

26 Jun '18

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2018-06-27 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 25 Jun '18

25 Jun '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-06-27 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

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

19 Jun '18

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2018-06-20 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

Re: Antora for Docs: making sure our contributors are on board
by Adam Samalik 18 Jun '18

18 Jun '18

Hi Leslie, That's right, we are working on introducing a new build mechanism for the Fedora Docs. The source format will still be asciidoc, the only thing that changes is how the files will be structured in the Pagure repository. To your second point, I think the best would be to let the owners of the docs know, and coordinate with them submitting your changes as a pull request to Pagure. Do you have it somewhere to preview? I think sending it to the list <docs(a)lists.fedoraproject.org> could be a good start. If you would like to help us with testing the new site or converting existing content, that would be great. If you want to have a look at the sources, see https://pagure.io/fork/bex/fedora-docs/docs-fp-o/tree/antora_playbook — it should have all the instructions to build the site, as well as links to other repositories where the content source (asciidoc files) live. Thanks, Adam On Tue, Jun 12, 2018 at 7:36 PM Leslie S Satenstein <lsatenstein(a)yahoo.com> wrote: > > Hi Adam > > I am new to the docs project. I am trying to understand your message. > Are you saying that there will be a new tool, Antora (I did visit the > website) and it is a way to provide a document management facility. > > *Related topic.* > ============ > > About 6 weeks ago, I pasted 3 Fedora docs into LibreOffice. My intent > was to mark them up, for grammar and sentence construction, using standard > industry markup tools. > > I used LibreOffice, and want to backport the LO corrections to asciidoc. > My markup corrections are in Canadian English with US spelling, given > Fedora's roots. > > My 80 hours of efforts are waiting for a "proof reader" partner who would > do a accept/reject of each markup, using the easy to use LibreOffice tools. > From there I would backport the corrected text. The backport, I understand > would be a PR, or another type of asciidoc submission. > > Of importance, I have a marked up 3 guides: admin guide, release guide, > and install guide. > > My markups, if accepted in their entirety would be a "better read" and > should offer better comprehension than the existing docs I cloned from the > Fedora Docs website. > > So far I have not been able to clone the existing asciidoc files. Is this > what Antora is about, allowing one submit new docs and/or to clone and > submit corrections? > > Do you need help to test. I am available almost 30hrs/week, (I am retired > after 55 years in IT, As a retirement activity I develop Linux software in > C/C++ or other fanciful languages. I also do blog write) > > > Regards > > > * Leslie* > *Leslie Satenstein* > *Montréal Québec, Canada* > > > > ------------------------------ > *From:* Adam Samalik <asamalik(a)redhat.com> > *To:* For participants of the Documentation Project < > docs(a)lists.fedoraproject.org> > *Cc:* Brian Exelbierd <bexelbie(a)redhat.com> > *Sent:* Tuesday, June 12, 2018 1:10 PM > *Subject:* Antora for Docs: making sure our contributors are on board > > As many of you have probably noticed, together with bex and few other > people I work on moving the Fedora Docs to Antora. It has many technical > benefits as well as an active community. Talking about community, I want to > make sure that when the time comes and we're ready to push this thing to > production, our contributors are on board. > > So I've just created a new epic: People! [1] > > "The main reason we go through all this trouble is people. We want to make > it simple for people to contribute to the docs. And might not be a bad idea > to make sure our contributors are on board when we go crazy and push this > thing to production." > > I'm looking for any useful input about making sure our contributors are on > board. I want this to be as smooth as possible. > > My thinking is: > > * Announce it here on this very list. > * Contact in advance every group having their docs on the site and: > ** making sure we have converted their asciibinder source into the Antora > source right > ** making sure they know how to make changes > * Do this over a few days, switching the Antora branches in all > repositories the site is built from to be the main branches. During these > few days, the current asciibinder site wouldn't update. All updates from > this period would end up on the new site. Basically, doing a few-days-log > freeze. > > How does that sound? Anything I've missed? > > Thanks! > Adam > > [1] > https://taiga.fedorainfracloud.org/project/asamalik-antora-for-docs/epic/58 > > -- > > Adam Šamalík > --------------------------- > Software Engineer > Red Hat > _______________________________________________ > docs mailing list -- docs(a)lists.fedoraproject.org > To unsubscribe send an email to docs-leave(a)lists.fedoraproject.org > Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html > List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines > List Archives: > https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org/… > > > -- Adam Šamalík --------------------------- Software Engineer Red Hat

2 1

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

18 Jun '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-06-20 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

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

12 Jun '18

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2018-06-13 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 11 Jun '18

11 Jun '18

Dear all, You are kindly invited to the meeting: Docs Writing Hour on 2018-06-13 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

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs June 2018