#79 Fix a few links and add various corrections
Merged 4 years ago by sumantrom. Opened 4 years ago by pbokoc.
pbokoc/mentored-projects corrections  into  master

@@ -18,31 +18,32 @@ 

  The following people are available to provide general help and

  support for the GSoD program.

  

- * link:https://fedoraproject.org/wiki/user/Pbokoc[Petr Bokoč]: Professional Technical Writer with Red Hat focused on Fedora and other community documentation.

- 	- Email : pbokoc@redhat.com

- 	- IRC nick : pbokoc on freenode

+ * link:https://fedoraproject.org/wiki/user/Pbokoc[Petr Bokoč]: Technical Writer with Red Hat, focused on Fedora and other community documentation.

+ 	- Email: pbokoc@redhat.com

+ 	- IRC nick: pbokoc on freenode (#fedora-docs)

+ 	- Mailing list: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org/

  * link:https://twitter.com/shaunm[Shaun McCance]: Upstream Documentation focused Community Human with extensive experience in Gnome and other communities. He is general mentor for the Fedora GSoD and will be heping folks with onboarding and getting started with Technical Writing.

- 	- Email : shaunm@redhat.com

+ 	- Email: shaunm@redhat.com

  * link:https://fedoraproject.org/wiki/User:riecatnor[Marie Nordin]: Marie Nordin is the Fedora Project's Community Action and Impact Coordinator(FCAIC), stepping into the role in fall of 2019. She is a long term contributor to Fedora, beginning in 2013 with an Outreachy internship for Fedora Badges design. Marie is a member of the Fedora Design team and the lead design maintainer of Fedora Badges. Over the years she has created 100's of designs for Fedora and mentored many new design contributors.She is the Co-admin for the GSoD this year.

- 	- Email : mnordin@redhat.com

- 	- IRC : riecatnor on freenode

- * link:https://fedoraproject.org/wiki/User:Sumantrom[Sumantro Mukherjee]: Administrator for this program with extensive experience in new contributor onboarding, development, and Linux. Admin for GCI and GSoC for Fedora Project for last couple of years and open source contributor for 6 odd years. Loves to onbaording new contributors to Open Source and mentor. 

- 	- Email : sumantro@redhat.com

- 	- IRC : sumantrom on freenode #fedora-join,#fedora-qa,#fedora-summer-coding,#fedora-docs

+ 	- Email: mnordin@redhat.com

+ 	- IRC: riecatnor on freenode

+ * link:https://fedoraproject.org/wiki/User:Sumantrom[Sumantro Mukherjee]: Administrator for this program with extensive experience in new contributor onboarding, development, and Linux. Admin for GCI and GSoC for Fedora Project for last couple of years and open source contributor for 6 odd years. Loves to onbaording new contributors to Open Source and mentor.

+ 	- Email: sumantro@redhat.com

+ 	- IRC: sumantrom on freenode (#fedora-join, #fedora-qa, #fedora-summer-coding ,#fedora-docs)

  * link:https://github.com/ffmancera[Fernando]: Fernando,is a Software Engineer at Red Hat working mainly in the nmstate project developing new features and fixing bugs. He has also done some work in Linux kernel and Tor project on his spare time.

- 	- Email : ferferna@redhat.com

- 	- IRC : ffmancera on freenode #nmstate

- 	- Mailing List : https://lists.fedorahosted.org/admin/lists/nmstate-devel.lists.fedorahosted.org

+ 	- Email: ferferna@redhat.com

+ 	- IRC: ffmancera on freenode (#nmstate)

+ 	- Mailing List: https://lists.fedorahosted.org/admin/lists/nmstate-devel.lists.fedorahosted.org

  * Antonio Cardace: Antonio Cardace,Software Engineer at Red Hat working on NetworkManager.

- 	- Email : acardace@redhat.com

- 	- IRC : acardace on freenode #nm

+ 	- Email: acardace@redhat.com

+ 	- IRC: acardace on freenode (#nm)

  	- Mailing List : networkmanager-list@gnome.org

  * Thomas Haller: Thomas Haller is an active member in the upstream NetworkManager community and working for Red Hat.

- 	- Email : thaller@redhat.com

+ 	- Email: thaller@redhat.com

  * link:https://fedoraproject.org/wiki/User:Till[Till Mass] : Till is long time Fedora contributor and Red Hatter working on nmstate. He has contributed to various parts of the project and currently is a part of the Fedora Council.

- 	- Email : timass@redhat.com

- 	- IRC :  tyll on Freenode #fedora-releng #fedora-admin #fedora-apps #fedora-devel #epel #nmstate

- 	- Mailing List : https://lists.fedorahosted.org/admin/lists/nmstate-devel.lists.fedorahosted.org

+ 	- Email: timass@redhat.com

+ 	- IRC:  tyll on Freenode (#fedora-releng, #fedora-admin, #fedora-apps, #fedora-devel, #epel, #nmstate)

+ 	- Mailing List: https://lists.fedorahosted.org/admin/lists/nmstate-devel.lists.fedorahosted.org

  

  == Projects

  
@@ -73,9 +74,9 @@ 

  [cols="20%a,30%a,50%a",options="header"]

  |===

  | Projects             | Mentors          | Tasks

- | Network Manager               |* Antonio Cardace (acardace@redhat.com) 

+ | Network Manager               |* Antonio Cardace (acardace@redhat.com)

  * Thomas Haller (thaller@redhat.com)

- * Beniamino Galvani (bgalvani@redhat.com)  | 

+ * Beniamino Galvani (bgalvani@redhat.com)  |

  * Write new content, explaining certain aspects of how NetworkManager works. In particular, a high level overview of how NetworkManager works and `howtos`.

  * Reorganize and restructure the content on our Github Pages and Documentation

  ** Better link to useful resources (e.g. distributions specific NetworkManager pages, our documentation, or useful blog articles).
@@ -91,32 +92,30 @@ 

  * The D-Bus API reference gets generated from the introspection D-Bus description in XML. This is probably the part that requires the least amount of work, but should also be reviewed whether there can be anything improved.

  * Improve NetworkManager’s README file in our git as this is also a good starting point for contributors.

  

- | Nmstate | * Fernando Fernando Mancera (ferferna@redhat.com) 

+ | Nmstate | * Fernando Fernando Mancera (ferferna@redhat.com)

  * Till Maas (till@redhat.com)| * Nmstate’s documentation currently does not contain a getting started guide. We’d like the technical writer to create a complete guide on how to start using nmstate.

  ** Create detailed usage examples using the different features that nmstare supports

  ** This getting started would be added to our link:https://www.nmstate.io/[official webpage] generated from this link:https://github.com/nmstate/nmstate.github.io[git repository]

  * Nmstate’s API documentation is currently allocated in the official webpage. The current API documentation is outdated and lacking details. We’d like the technical writer to update and complete the current API documentation

- This documentation is generated from this link:https://github.com/nmstate/nmstate.github.io[ git] repository

+ This documentation is generated from this link:https://github.com/nmstate/nmstate.github.io[git] repository

  

- |Fedora Docs|  * Petr Bokoc (pbokoc@redhat.com) 

+ |Fedora Docs|  * Petr Bokoc (pbokoc@redhat.com)

  * Sumantro Mukherjee (sumantro@redhat.com)|* Update and refactor the Fedora Installation Guide

  

- ** The current Fedora Installation Guide (https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/), while adequate, has been converted from a different publishing toolchain a few years ago and never updated to take advantage of the new, modular toolchain, Antora, that the Fedora Documentation Project currently uses. Additionally, parts of the Installation Guide are also being used inside the graphical installer to provide built-in help, however, at present time the installer is forced to use old, pre-conversion sources.

- 

+ ** The current link:https://docs.fedoraproject.org/en-US/fedora/f32/install-guide/[Fedora Installation Guide], while adequate, has been converted from a different publishing toolchain a few years ago and never updated to take advantage of the new, modular toolchain, Antora, that the Fedora Documentation Project currently uses. Additionally, parts of the Installation Guide are also being used inside the graphical installer to provide built-in help, however, at present time the installer is forced to use old, pre-conversion sources.

+ +

  We would like to fix all issues described above. A writer working on this project would be expected to:

- 

+ +

      ** Modularize the guide so that it functions as a set of standalone modules and leverages the advantages of Antora, instead of the current hierarchical structure. This involves restructing the source file structure and updating all internal references (xrefs).

- 

-    ** Work with the installer development team to ensure that the Installation Guide can be used as sources for the installer built-in help. People both in the Fedora Documentation Project as well as in the installer development team have prior experience with doing this and will be able to provide help.

- 

- The Installation Guide is written using the ASCIIDoc markup language (http://asciidoc.org/). Sources are store in git, and they are published using Antora (https://antora.org/). Familiarity with any of these tools, as well as basic scripting, is preferred but not necessary.

+ +

+    ** Work with the installer development team to ensure that the Installation Guide can be used as sources for the installer built-in help. People both in the Fedora Documentation Project as well as in the installer development team have prior experience with doing this, and will be able to provide help.

  

  * Develop a set of documentation showcasing Fedora's features

- 

+ +

  ** Fedora Documentation is missing a set of docs aimed at people considering switching to Linux and Fedora in particular from other operating systems, notably MS Windows. We would like to create documentation that showcases Fedora's features relevant to a home user's general use cases, such as web browsing, multimedia creation and editing, video playback, etc.

- 

+ +

  ** A writer working on creating such a doc set would be expected to work with various stakeholders in the Fedora Project such as the Mindshare Committee and project leadership, identify personas and their specific use cases, and then create documentation covering these use cases.

  

+ Fedora documentation is written using the link:http://asciidoc.org/[ASCIIDoc markup language]. Sources are stored in git, and they are published using link:https://antora.org/[Antora]. Familiarity with any of these tools, as well as basic scripting, is preferred but not necessary.

  

  |===

- 

@@ -12,7 +12,7 @@ 

  

  == What is Google Season of Docs?

  

- Season of Docs, a new program which fosters the open source contributions of technical writers.

+ Season of Docs, a program which fosters the open source contributions of technical writers.

  Season of Docs brings technical writers and open source projects together for a few months to work on open source documentation.

  Fedora is excited to take part in it!

  
@@ -22,7 +22,7 @@ 

  Fedora is still in the process of applying to be a mentoring organization.

  Today there is nothing we can do except wait until Google makes a decision.

  

- Today you should read through the xref:gsod/2020/ideas.adoc/#_ideas[ideas list] and see what interests you.

+ Today you should read through the xref:gsod/2020/ideas.adoc#_ideas[ideas list] and see what interests you.

  You can also start a conversation with our mentors about your own idea.

  

  [[writer-information]]

Nothing groundbreaking, just a fix to a few links, a few typo fixes, and I fixed the list in the big table on the Ideas page so it has the intended hierarchy.

Pull-Request has been merged by sumantrom

4 years ago