From a8d4d7d241cf9fafbc73b7cf62e1983766a01d11 Mon Sep 17 00:00:00 2001 From: Aneta Šteflová Petrová Date: Aug 22 2017 18:37:50 +0000 Subject: Tweak the handout: simplify it, make some fixes --- diff --git a/README.adoc b/README.adoc index 7d1abb2..c402b2c 100644 --- a/README.adoc +++ b/README.adoc @@ -7,31 +7,27 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For // Suitable for handouts distributed around the venue *before* the workshop and *at* the workshop. .What can I expect to get from the workshop? -Learn what the plan is to revive Fedora docs. Learn how to contribute to a modular guide. - -.What will I accomplish by the end of the workshop? - -Make a contribution to a modular Fedora guide. +Learn about the plan to revive Fedora docs. Learn how to contribute to a Fedora modular guide. .What should I do before going to the workshop? -* Clone this link:https://pagure.io/fedora-docs/flock2017-docs-workshop[repo]. It holds the content we will be contributing to. +* Clone this link:https://pagure.io/fedora-docs/flock2017-docs-workshop[repo] and fork it. + ---- -$ git clone ssh://git@pagure.io/forks/aneta/fedora-docs/flock2017-docs-workshop.git +$ git clone ssh://git@pagure.io/fedora-docs/flock2017-docs-workshop.git ---- + -Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. +The repo holds a modular guide we will be contributing to. + -To contribute to the repository, push to your fork and then open pull requests. +* Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. + -* Install asciidoctor. +* Install *asciidoctor*. + ---- # dnf install asciidoctor ---- + -* Browse this link:https://rkratky.fedorapeople.org/moddocs/[Modular Documentation Reference Guide]. +* Browse this link:https://rkratky.fedorapeople.org/moddocs/[Modular Documentation Reference Guide], especially _Chapter 3. Writing Modular Documentation_. .What does modular documentation look like? @@ -42,10 +38,10 @@ image::modules_assemblies.png[] // Robert, I added the image to the root repo dir. I didn't know where else to put it, feel free to move it somewhere else. // The rest makes sense only for handouts *at* the workshop. -.I've chosen a module that I want to describe. What do I do exactly? +.I've chosen a module that I want to write. What do I do exactly? . Open the corresponding placeholder file we've created in the repo. For example: `flock2017-docs-workshop/en-US/procedure-adding_users_to_user_groups.adoc`. -. Replace the contents of the placeholder files with your docs. You can use the existing sections link:https://bex.fedorapeople.org/fedora-docs-web/f26/system-administrators-guide/basic-system-configuration/Managing_Users_and_Groups.html[Managing users and Groups] or link:https://docs.fedoraproject.org/en-US/Fedora/25/html/SELinux_Users_and_Administrators_Guide/sect-Managing_Confined_Services-MariaDB-Configuration_Examples.html#sect-Managing_Confined_Services-MariaDB-Configuration_Examples-Changing_Database_Location[MariaDB Changing Database Location]. Browse through them and pick the pieces that fit your assignment. +. Replace the contents of the placeholder files with your docs. You can use the existing sections link:https://bex.fedorapeople.org/fedora-docs-web/f26/system-administrators-guide/basic-system-configuration/Managing_Users_and_Groups.html[Managing users and Groups] or link:https://docs.fedoraproject.org/en-US/Fedora/25/html/SELinux_Users_and_Administrators_Guide/sect-Managing_Confined_Services-MariaDB-Configuration_Examples.html#sect-Managing_Confined_Services-MariaDB-Configuration_Examples-Changing_Database_Location[MariaDB Changing Database Location]: browse through them and pick the pieces that fit your module. .I've added some docs to the repo, and now I want to see the whole book. How do I preview it?