From f83d17dc8949540e30507ae7568940bf4427ed39 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:42:22 +0000 Subject: [PATCH 1/12] Remove adoc README. --- diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 77f05bb..0000000 --- a/README.adoc +++ /dev/null @@ -1,62 +0,0 @@ -= AsciiBinder-Based Docs Repo - -This docs repository was created with http://asciibinder.org/[AsciiBinder]. For more information on how AsciiBinder works, check out the http://asciibinder.org/latest/[documentation]. - -== Workshop Handout - -// Suitable for handouts distributed around the venue *before* the workshop and *at* the workshop. -.What can I expect to get from the workshop? - -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] and fork it. -+ ----- -$ git clone ssh://git@pagure.io/fedora-docs/flock2017-docs-workshop.git ----- -+ -The repo holds a modular guide we will be contributing to. -+ -* Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. See link:https://docs.pagure.org/pagure/usage/first_steps.html[First Steps on pagure]. -+ -* Install *asciidoctor*. -+ ----- -# dnf install asciidoctor ----- -+ -* Browse this link:https://rkratky.fedorapeople.org/moddocs/[Modular Documentation Reference Guide], especially _Chapter 3. Writing Modular Documentation_. - -.This workshop is about 'modular documentation based on user stories'. What is that? - -Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ - -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 have chosen a module that I want to write. What do I do exactly? - -. Open the corresponding placeholder file 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 module. - -.I have added some docs to the repo, and now I want to see the whole book. How do I preview it? - -TBD - -// Robert, can you please add this? I don't know if people should use asciidoctor, asciibinder, or what. - -.I have added some docs to the repo and verified the book preview. How do I share my work? - -Use the standard workflow: push to a branch in your fork and open a pull request. - -== License - -image:http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg["Creative Commons License",height=31px,width=88px] - -This work is licensed under a http://creativecommons.org/licenses/by/4.0/[Creative Commons Attribution 4.0 International License]. - -See link:LICENSE.txt[LICENSE.txt]. From a8b0f8f15c160050a0f9de35c4609314c8f6f8fd Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:44:58 +0000 Subject: [PATCH 2/12] Create Markdown README. --- diff --git a/README.md b/README.md new file mode 100644 index 0000000..a1decae --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Docs Workshop Repo + +This docs repository was created with http://asciibinder.org/[AsciiBinder]. For more information on how AsciiBinder works, check out the http://asciibinder.org/latest/[documentation]. + +## How to Work with the Repo + +. Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. See [First Steps on pagure](https://docs.pagure.org/pagure/usage/first_steps.html). +. Fork the repo to your *pagure.io* namespace (click the **Fork** button in the top-right corner of this repo's main page). +. Clone the repo to your machine: + ``` + git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git + ``` +. Change to the `en-US/sysadmin_user_stories/` directory. +. Start hacking on assemblies and modules. See the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/), especially _Chapter 3. Writing Modular Documentation_. + +### Understanding User Story-Based and Modular Docs + +This workshop is about *modular documentation based on user stories*. What is that? + +Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ + +![module and assemblies schema](modules_assemblies.png "modules and assemblies") + +For a thorough explanation, description of different types of modules, and real-world examples, see the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/). + +### Previewing the Docs + +. Make sure you have *Asciidoctor* installed: + ``` + # dnf install asciidoctor + ``` +. Run `asciidoctor` on the `index.adoc` file in the repo's root: + ``` + $ asciidoctor -a toc -n index.adoc + ``` +. Open the resulting HTML file in a browser of your choice: + ``` + $ index.html + ``` From d1d7250933d899513c9e2e19614afdd5f50e63ae Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:45:24 +0000 Subject: [PATCH 3/12] Create master index file. --- diff --git a/index.adoc b/index.adoc new file mode 100644 index 0000000..2c6bc85 --- /dev/null +++ b/index.adoc @@ -0,0 +1,15 @@ +[#sysadmin_user_stories] += SysAdmin User Stories + +include::en-US/sysadmin_user_stories/assembly-adding_new_user_accounts.adoc[leveloffset=+1] + +include::en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc[leveloffset=+1] + +include::en-US/sysadmin_user_stories/assembly-adjusting_file_permissions.adoc[leveloffset=+1] + +include::en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc[leveloffset=+1] + +include::en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc[leveloffset=+1] + +include::en-US/sysadmin_user_stories/assembly-changing_default_database_location.adoc[leveloffset=+1] + From b9e8bf96439c3bb1e10d03a8f5162c6d94ca3c66 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:45:58 +0000 Subject: [PATCH 4/12] Create two handouts for before and during the workshop. --- diff --git a/handout-pre.adoc b/handout-pre.adoc new file mode 100644 index 0000000..a561d17 --- /dev/null +++ b/handout-pre.adoc @@ -0,0 +1,32 @@ += Documentation Workshop: What to Expect + +// Suitable for handouts distributed around the venue *before* the workshop and *at* the workshop. +.What can I expect to get from the workshop? + +Learn about the plan to revive Fedora docs. Learn how to contribute to a modular Fedora guide. + +.What should I do before going to the workshop? + +* Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. +* Fork this repo: https://pagure.io/fedora-docs/flock2017-docs-workshop. +* Clone the forked repo to your machine: ++ +---- +$ git clone ssh://git@pagure.io/fedora-docs/flock2017-docs-workshop.git +---- ++ +The repo holds a modular guide we will be contributing to. + +* Make sure you have *Asciidoctor* installed: ++ +---- +# dnf install asciidoctor +---- + +* Browse the Modular Documentation Reference Guide: https://rkratky.fedorapeople.org/moddocs/, especially _Chapter 3. Writing Modular Documentation_. + +.This workshop is about 'modular documentation based on user stories'. What is that? + +Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ + +image::modules_assemblies.png[] diff --git a/handout-ws.adoc b/handout-ws.adoc new file mode 100644 index 0000000..73684d2 --- /dev/null +++ b/handout-ws.adoc @@ -0,0 +1,25 @@ += Documentation Workshop: User Story-Based & modular Documentation + +// The rest makes sense only for handouts *at* the workshop. +.I have chosen a module that I want to write. What do I do exactly? + +. Open the corresponding placeholder file 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 reuse existing sections from the System Administration Guide (_Managing Users and Groups_ or _MariaDB Changing Database Location_); browse through them and pick the pieces that fit your module. + +.I have added some docs to the repo, and now I want to see the whole book. How do I preview it? + +. Run `asciidoctor` on the `master.adoc` file in the repo's root: ++ +---- +$ asciidoctor -a toc -n master.adoc +---- + +. Open the resulting HTML file in a browser of your choice: ++ +---- +$ master.html +---- + +.I have added some docs to the repo and verified the book preview. How do I share my work? + +Use the standard workflow: push to a branch in your fork and open a pull request. From 230ca485b9b204ba04d6da75155e56f88cd33bcd Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:50:44 +0000 Subject: [PATCH 5/12] Fix md markup. --- diff --git a/README.md b/README.md index a1decae..64d2f33 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,40 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For ## How to Work with the Repo -. Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. See [First Steps on pagure](https://docs.pagure.org/pagure/usage/first_steps.html). -. Fork the repo to your *pagure.io* namespace (click the **Fork** button in the top-right corner of this repo's main page). -. Clone the repo to your machine: +1. Make sure you have an account on *pagure.io* and that you have uploaded your SSH key to the account. See [First Steps on pagure](https://docs.pagure.org/pagure/usage/first_steps.html). + +2. Fork the repo to your *pagure.io* namespace (click the **Fork** button in the top-right corner of this repo's main page). + +3. Clone the repo to your machine: ``` git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git ``` -. Change to the `en-US/sysadmin_user_stories/` directory. -. Start hacking on assemblies and modules. See the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/), especially _Chapter 3. Writing Modular Documentation_. + +4. Change to the `en-US/sysadmin_user_stories/` directory. + +5. Start hacking on assemblies and modules. See the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/), especially _Chapter 3. Writing Modular Documentation_. ### Understanding User Story-Based and Modular Docs This workshop is about *modular documentation based on user stories*. What is that? -Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ - -![module and assemblies schema](modules_assemblies.png "modules and assemblies") +Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ See a [module and assemblies schema](modules_assemblies.png). For a thorough explanation, description of different types of modules, and real-world examples, see the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/). ### Previewing the Docs -. Make sure you have *Asciidoctor* installed: +1. Make sure you have *Asciidoctor* installed: ``` # dnf install asciidoctor ``` -. Run `asciidoctor` on the `index.adoc` file in the repo's root: + +2. Run `asciidoctor` on the `index.adoc` file in the repo's root: ``` $ asciidoctor -a toc -n index.adoc ``` -. Open the resulting HTML file in a browser of your choice: + +3. Open the resulting HTML file in a browser of your choice: ``` $ index.html ``` From a8b0a3b587cbdbb99f899bbeaceb365f9ef61d5d Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:55:24 +0000 Subject: [PATCH 6/12] Fix md markup 2. --- diff --git a/README.md b/README.md index 64d2f33..f7a2f05 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,10 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For 2. Fork the repo to your *pagure.io* namespace (click the **Fork** button in the top-right corner of this repo's main page). 3. Clone the repo to your machine: - ``` - git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git - ``` + + ``` + git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git + ``` 4. Change to the `en-US/sysadmin_user_stories/` directory. @@ -21,23 +22,26 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For This workshop is about *modular documentation based on user stories*. What is that? -Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ See a [module and assemblies schema](modules_assemblies.png). +Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ See a [module and assemblies schema](https://pagure.io/fedora-docs/flock2017-docs-workshop/blob/master/f/modules_assemblies.png). For a thorough explanation, description of different types of modules, and real-world examples, see the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/). ### Previewing the Docs 1. Make sure you have *Asciidoctor* installed: - ``` - # dnf install asciidoctor - ``` + + ``` + # dnf install asciidoctor + ``` 2. Run `asciidoctor` on the `index.adoc` file in the repo's root: - ``` - $ asciidoctor -a toc -n index.adoc - ``` + + ``` + $ asciidoctor -a toc -n index.adoc + ``` 3. Open the resulting HTML file in a browser of your choice: - ``` - $ index.html - ``` + + ``` + $ index.html + ``` From edc3a25945254952181ed97c18262ada5f026f80 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 15:57:15 +0000 Subject: [PATCH 7/12] Fix md markup 3. --- diff --git a/README.md b/README.md index f7a2f05..8aac124 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For 2. Fork the repo to your *pagure.io* namespace (click the **Fork** button in the top-right corner of this repo's main page). -3. Clone the repo to your machine: - +3. Clone the repo to your machine: ``` git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git ``` @@ -28,20 +27,17 @@ For a thorough explanation, description of different types of modules, and real- ### Previewing the Docs -1. Make sure you have *Asciidoctor* installed: - +1. Make sure you have *Asciidoctor* installed: ``` # dnf install asciidoctor ``` -2. Run `asciidoctor` on the `index.adoc` file in the repo's root: - +2. Run `asciidoctor` on the `index.adoc` file in the repo's root: ``` $ asciidoctor -a toc -n index.adoc ``` -3. Open the resulting HTML file in a browser of your choice: - +3. Open the resulting HTML file in a browser of your choice: ``` $ index.html ``` From d7359bf8346938fceada13278ecf548e3790d444 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 16:32:22 +0000 Subject: [PATCH 8/12] Moar fixes; asciiart. --- diff --git a/README.md b/README.md index 8aac124..6d3e4fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Docs Workshop Repo -This docs repository was created with http://asciibinder.org/[AsciiBinder]. For more information on how AsciiBinder works, check out the http://asciibinder.org/latest/[documentation]. +This docs repository was created with [AsciiBinder](http://asciibinder.org/). For more information on how AsciiBinder works, check out the [documentation](http://asciibinder.org/latest/). ## How to Work with the Repo @@ -21,8 +21,35 @@ This docs repository was created with http://asciibinder.org/[AsciiBinder]. For This workshop is about *modular documentation based on user stories*. What is that? -Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ See a [module and assemblies schema](https://pagure.io/fedora-docs/flock2017-docs-workshop/blob/master/f/modules_assemblies.png). - +Modular documentation is documentation based on _modules_, which the writer combines into _assemblies_ (think articles). Each assembly documents a _user story_, which is a task description in the form of a sentence like this: _As a , I want to so that ._ + +**Simple schema of possible module combinations and reuse** + +``` ++-------------------+ +-------------------+ +-------------------+ +| | | | | | +| ASSEMBLY 1 | | ASSEMBLY 2 | | ASSEMBLY 3 | +| | | | | | +| Assembly intro | | Assembly intro | | Assembly intro | +| | | | | | +| +---------------+ | | +---------------+ | | +---------------+ | +| | Module A | | | | Module D | | | | Module G | | +| +---------------+ | | +---------------+ | | +---------------+ | +| +---------------+ | | +---------------+ | | +---------------+ | +| | Module B | | | | Module E | | | | Assembly 1 | | +| +---------------+ | | +---------------+ | | +---------------+ | +| +---------------+ | | +---------------+ | | +---------------+ | +| | Module C | | | | Module F | | | | Module H | | +| +---------------+ | | +---------------+ | | +---------------+ | +| | | +---------------+ | | | +| Additional res. | | | Module C | | | Additional res. | +| | | +---------------+ | | | ++-------------------+ | | +-------------------+ + | Additional res. | + | | + +-------------------+ +``` + For a thorough explanation, description of different types of modules, and real-world examples, see the [Modular Documentation Reference Guide](https://rkratky.fedorapeople.org/moddocs/). ### Previewing the Docs @@ -41,3 +68,11 @@ For a thorough explanation, description of different types of modules, and real- ``` $ index.html ``` + +### Submitting Your Contribution + +You have added some docs to the repo and verified the book preview. How do you share your work? Use the standard workflow: + +1. Push to the work branch in your fork. + +2. Open a pull request against the original [Docs Workshop Repo](https://pagure.io/fedora-docs/flock2017-docs-workshop). diff --git a/handout-pre.adoc b/handout-pre.adoc index a561d17..a446416 100644 --- a/handout-pre.adoc +++ b/handout-pre.adoc @@ -12,7 +12,7 @@ Learn about the plan to revive Fedora docs. Learn how to contribute to a modular * Clone the forked repo to your machine: + ---- -$ git clone ssh://git@pagure.io/fedora-docs/flock2017-docs-workshop.git +$ git clone ssh://git@pagure.io/forks//fedora-docs/flock2017-docs-workshop.git ---- + The repo holds a modular guide we will be contributing to. diff --git a/handout-ws.adoc b/handout-ws.adoc index 73684d2..c141057 100644 --- a/handout-ws.adoc +++ b/handout-ws.adoc @@ -8,16 +8,16 @@ .I have added some docs to the repo, and now I want to see the whole book. How do I preview it? -. Run `asciidoctor` on the `master.adoc` file in the repo's root: +. Run `asciidoctor` on the `index.adoc` file in the repo's root: + ---- -$ asciidoctor -a toc -n master.adoc +$ asciidoctor -a toc -n index.adoc ---- . Open the resulting HTML file in a browser of your choice: + ---- -$ master.html +$ index.html ---- .I have added some docs to the repo and verified the book preview. How do I share my work? From 6652c630c8e30df339fe34284ba42b7eb9996693 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 17:12:51 +0000 Subject: [PATCH 9/12] Add index.html to gitignore. --- diff --git a/.gitignore b/.gitignore index 462d167..cc16fe1 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ _package *.swp diag-*.png diag-*.png.cache +index.html ## Project-specific ignores From 4844e315e07eee25d8f28e925506e27a57791315 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 17:13:22 +0000 Subject: [PATCH 10/12] Prep handouts for PDF output, add PDFs to repo. --- diff --git a/handout-pre.adoc b/handout-pre.adoc index a446416..11489d6 100644 --- a/handout-pre.adoc +++ b/handout-pre.adoc @@ -1,4 +1,7 @@ -= Documentation Workshop: What to Expect +:last-update-label!: +:doctype: article + +== Documentation Workshop: What to Expect // Suitable for handouts distributed around the venue *before* the workshop and *at* the workshop. .What can I expect to get from the workshop? @@ -23,7 +26,7 @@ The repo holds a modular guide we will be contributing to. # dnf install asciidoctor ---- -* Browse the Modular Documentation Reference Guide: https://rkratky.fedorapeople.org/moddocs/, especially _Chapter 3. Writing Modular Documentation_. +* Browse the Modular Documentation Reference Guide, especially _Chapter 3. Writing Modular Documentation_: https://rkratky.fedorapeople.org/moddocs/. .This workshop is about 'modular documentation based on user stories'. What is that? diff --git a/handout-pre.pdf b/handout-pre.pdf new file mode 100644 index 0000000..f4c75ab --- /dev/null +++ b/handout-pre.pdf @@ -0,0 +1,1195 @@ +%PDF-1.3 +%���� +1 0 obj +<< /Title (Documentation Workshop: What to Expect) +/Creator (Asciidoctor PDF 1.5.0.alpha.13, based on Prawn 2.1.0) +/Producer (Asciidoctor PDF 1.5.0.alpha.13, based on Prawn 2.1.0) +/CreationDate (D:20170825185149+02'00') +/ModDate (D:20170825185149+02'00') +>> +endobj +2 0 obj +<< /Type /Catalog +/Pages 3 0 R +/Names 9 0 R +/Outlines 21 0 R +/PageLabels 24 0 R +/PageMode /UseOutlines +/OpenAction [7 0 R /FitH 842.89] +/ViewerPreferences << /DisplayDocTitle true +>> +>> +endobj +3 0 obj +<< /Type /Pages +/Count 1 +/Kids [7 0 R] +>> +endobj +4 0 obj +<< /Length 2 +>> +stream +q + +endstream +endobj +5 0 obj +<< /Type /Page +/Parent 3 0 R +/MediaBox [0 0 595.28 841.89] +/Contents 4 0 R +/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI] +>> +>> +endobj +6 0 obj +<< /Length 9626 +>> +stream +q +/DeviceRGB cs +0.200 0.200 0.200 scn +/DeviceRGB CS +0.200 0.200 0.200 SCN + +BT +48.24 782.394 Td +/F2.0 22 Tf +[<446f63756d656e746174696f6e2057> 60.0586 <6f726b73686f703a205768617420746f20457870656374>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +48.24 753.206 Td +/F3.0 10.5 Tf +<576861742063616e20492065787065637420746f206765742066726f6d2074686520776f726b73686f703f> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +48.24 733.426 Td +/F1.0 10.5 Tf +[<4c6561726e2061626f75742074686520706c616e20746f207265766976652046> 40.0391 <65646f72> 20.0195 <6120646f63732e204c6561726e20686f7720746f20636f6e7472696275746520746f2061206d6f64756c61722046> 40.0391 <65646f72> 20.0195 <612067756964652e>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +48.24 705.646 Td +/F3.0 10.5 Tf +<576861742073686f756c64204920646f206265666f726520676f696e6720746f2074686520776f726b73686f703f> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +-0.5 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +56.8805 685.866 Td +/F1.0 10.5 Tf + Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +0.0 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.6871 Tw + +BT +66.24 685.866 Td +/F1.0 10.5 Tf +[<4d616b> 20.0195 <65207375726520796f75206861766520616e206163636f756e74206f6e20>] TJ +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.6871 Tw + +BT +247.1348 685.866 Td +/F2.0 10.5 Tf +<7061677572652e696f> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.6871 Tw + +BT +297.7343 685.866 Td +/F1.0 10.5 Tf +[<20616e64207468617420796f7520686176652075706c6f6164656420796f757220535348206b> 20.0195 <657920746f20746865>] TJ +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 670.086 Td +/F1.0 10.5 Tf +<6163636f756e742e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +-0.5 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +56.8805 648.306 Td +/F1.0 10.5 Tf + Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +0.0 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 648.306 Td +/F1.0 10.5 Tf +[<46> 40.0391 <6f726b2074686973207265706f3a20>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.259 0.545 0.792 scn +0.259 0.545 0.792 SCN + +BT +141.7976 648.306 Td +/F1.0 10.5 Tf +[<68747470733a2f2f7061677572652e696f2f6665646f72> 20.0195 <612d646f63732f666c6f636b323031372d646f63732d776f726b73686f70>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +414.5664 648.306 Td +/F1.0 10.5 Tf +<2e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +-0.5 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +56.8805 626.526 Td +/F1.0 10.5 Tf + Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +0.0 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 626.526 Td +/F1.0 10.5 Tf +[<436c6f6e652074686520666f726b> 20.0195 <6564207265706f20746f20796f7572206d616368696e653a>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +q +0.961 0.961 0.961 scn +70.24 610.71 m +543.04 610.71 l +545.2491 610.71 547.04 608.9191 547.04 606.71 c +547.04 563.23 l +547.04 561.0209 545.2491 559.23 543.04 559.23 c +70.24 559.23 l +68.0309 559.23 66.24 561.0209 66.24 563.23 c +66.24 606.71 l +66.24 608.9191 68.0309 610.71 70.24 610.71 c +h +f +0.800 0.800 0.800 SCN +0.75 w +70.24 610.71 m +543.04 610.71 l +545.2491 610.71 547.04 608.9191 547.04 606.71 c +547.04 563.23 l +547.04 561.0209 545.2491 559.23 543.04 559.23 c +70.24 559.23 l +68.0309 559.23 66.24 561.0209 66.24 563.23 c +66.24 606.71 l +66.24 608.9191 68.0309 610.71 70.24 610.71 c +h +S +Q +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +77.24 587.885 Td +/F4.0 11 Tf +<242067697420636c6f6e65207373683a2f2f676974407061677572652e696f2f666f726b732f3c757365726e616d653e2f6665646f72612d646f63732f666c6f636b323031372d646f63732d> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +77.24 573.145 Td +/F4.0 11 Tf +<776f726b73686f702e676974> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 535.266 Td +/F1.0 10.5 Tf +<546865207265706f20686f6c64732061206d6f64756c61722067756964652077652077696c6c20626520636f6e747269627574696e6720746f2e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +-0.5 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +56.8805 507.486 Td +/F1.0 10.5 Tf + Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +0.0 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 507.486 Td +/F1.0 10.5 Tf +[<4d616b> 20.0195 <65207375726520796f75206861766520>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +169.2448 507.486 Td +/F2.0 10.5 Tf +<4173636969646f63746f72> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +230.0713 507.486 Td +/F1.0 10.5 Tf +<20696e7374616c6c65643a> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +q +0.961 0.961 0.961 scn +70.24 491.67 m +543.04 491.67 l +545.2491 491.67 547.04 489.8791 547.04 487.67 c +547.04 458.93 l +547.04 456.7209 545.2491 454.93 543.04 454.93 c +70.24 454.93 l +68.0309 454.93 66.24 456.7209 66.24 458.93 c +66.24 487.67 l +66.24 489.8791 68.0309 491.67 70.24 491.67 c +h +f +0.800 0.800 0.800 SCN +0.75 w +70.24 491.67 m +543.04 491.67 l +545.2491 491.67 547.04 489.8791 547.04 487.67 c +547.04 458.93 l +547.04 456.7209 545.2491 454.93 543.04 454.93 c +70.24 454.93 l +68.0309 454.93 66.24 456.7209 66.24 458.93 c +66.24 487.67 l +66.24 489.8791 68.0309 491.67 70.24 491.67 c +h +S +Q +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +77.24 468.845 Td +/F4.0 11 Tf +<2320646e6620696e7374616c6c206173636969646f63746f72> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +-0.5 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +56.8805 430.966 Td +/F1.0 10.5 Tf + Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +0.0 Tc +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +2.0375 Tw + +BT +66.24 430.966 Td +/F1.0 10.5 Tf +<42726f77736520746865204d6f64756c617220446f63756d656e746174696f6e205265666572656e63652047756964652c20657370656369616c6c7920> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +2.0375 Tw + +BT +404.6795 430.966 Td +/F3.0 10.5 Tf +<4368617074657220332e2057726974696e67204d6f64756c6172> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +66.24 415.186 Td +/F3.0 10.5 Tf +<446f63756d656e746174696f6e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +141.4515 415.186 Td +/F1.0 10.5 Tf +<3a20> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.259 0.545 0.792 scn +0.259 0.545 0.792 SCN + +BT +147.174 415.186 Td +/F1.0 10.5 Tf +[<68747470733a2f2f726b72> 20.0195 <61746b79> 89.8438 <2e6665646f72> 20.0195 <6170656f706c652e6f72672f6d6f64646f63732f>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +356.7657 415.186 Td +/F1.0 10.5 Tf +<2e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +48.24 387.406 Td +/F3.0 10.5 Tf +<5468697320776f726b73686f702069732061626f757420276d6f64756c617220646f63756d656e746174696f6e206261736564206f6e20757365722073746f72696573272e205768617420697320746861743f> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +3.0505 Tw + +BT +48.24 367.626 Td +/F1.0 10.5 Tf +<4d6f64756c617220646f63756d656e746174696f6e20697320646f63756d656e746174696f6e206261736564206f6e20> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +3.0505 Tw + +BT +328.182 367.626 Td +/F3.0 10.5 Tf +<6d6f64756c6573> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +3.0505 Tw + +BT +369.2055 367.626 Td +/F1.0 10.5 Tf +<2c207768696368207468652077726974657220636f6d62696e657320696e746f> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.2259 Tw + +BT +48.24 351.846 Td +/F3.0 10.5 Tf +<617373656d626c696573> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.2259 Tw + +BT +100.9395 351.846 Td +/F1.0 10.5 Tf +<20287468696e6b2061727469636c6573292e204561636820617373656d626c7920646f63756d656e7473206120> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.2259 Tw + +BT +326.4545 351.846 Td +/F3.0 10.5 Tf +<757365722073746f7279> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +0.2259 Tw + +BT +375.8205 351.846 Td +/F1.0 10.5 Tf +<2c2077686963682069732061207461736b206465736372697074696f6e20696e20746865> Tj +ET + + +0.0 Tw +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +48.24 336.066 Td +/F1.0 10.5 Tf +[<666f726d206f6620612073656e74656e6365206c696b> 20.0195 <6520746869733a20>] TJ +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +188.7613 336.066 Td +/F3.0 10.5 Tf +<41732061203c74797065206f6620757365723e2c20492077616e7420746f203c676f616c3e20736f2074686174203c726561736f6e3e2e> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn + +q +498.8 0.0 0.0 211.7332 48.24 108.5168 cm +/I1 Do +Q +q +0.000 0.000 0.000 scn +0.000 0.000 0.000 SCN +1 w +0 J +0 j +[] 0 d +/Stamp1 Do +0.200 0.200 0.200 scn +0.200 0.200 0.200 SCN + +BT +541.009 14.388 Td +/F1.0 9 Tf +<31> Tj +ET + +0.000 0.000 0.000 SCN +0.000 0.000 0.000 scn +Q +Q + +endstream +endobj +7 0 obj +<< /Type /Page +/Parent 3 0 R +/MediaBox [0 0 595.28 841.89] +/Contents 6 0 R +/Resources << /ProcSet [/PDF /Text /ImageB /ImageC /ImageI] +/Font << /F2.0 12 0 R +/F3.0 13 0 R +/F1.0 14 0 R +/F4.0 16 0 R +>> +/XObject << /I1 18 0 R +/Stamp1 19 0 R +>> +>> +/Annots [15 0 R 17 0 R] +>> +endobj +8 0 obj +[7 0 R /XYZ 0 841.89 null] +endobj +9 0 obj +<< /Type /Names +/Dests 10 0 R +>> +endobj +10 0 obj +<< /Names [(__anchor-top) 8 0 R (_documentation_workshop_what_to_expect) 11 0 R] +>> +endobj +11 0 obj +[7 0 R /XYZ 0 841.89 null] +endobj +12 0 obj +<< /Type /Font +/BaseFont /AAAAAA+NotoSerif-Bold +/Subtype /TrueType +/FontDescriptor 26 0 R +/FirstChar 32 +/LastChar 255 +/Widths 28 0 R +/ToUnicode 27 0 R +>> +endobj +13 0 obj +<< /Type /Font +/BaseFont /AAAAAB+NotoSerif-Italic +/Subtype /TrueType +/FontDescriptor 30 0 R +/FirstChar 32 +/LastChar 255 +/Widths 32 0 R +/ToUnicode 31 0 R +>> +endobj +14 0 obj +<< /Type /Font +/BaseFont /AAAAAC+NotoSerif +/Subtype /TrueType +/FontDescriptor 34 0 R +/FirstChar 32 +/LastChar 255 +/Widths 36 0 R +/ToUnicode 35 0 R +>> +endobj +15 0 obj +<< /Border [0 0 0] +/A << /Type /Action +/S /URI +/URI (https://pagure.io/fedora-docs/flock2017-docs-workshop) +>> +/Subtype /Link +/Rect [141.7976 645.24 414.5664 659.52] +/Type /Annot +>> +endobj +16 0 obj +<< /Type /Font +/BaseFont /AAAAAD+mplus1mn-regular +/Subtype /TrueType +/FontDescriptor 38 0 R +/FirstChar 32 +/LastChar 255 +/Widths 40 0 R +/ToUnicode 39 0 R +>> +endobj +17 0 obj +<< /Border [0 0 0] +/A << /Type /Action +/S /URI +/URI (https://rkratky.fedorapeople.org/moddocs/) +>> +/Subtype /Link +/Rect [147.174 412.12 356.7657 426.4] +/Type /Annot +>> +endobj +18 0 obj +<< /Type /XObject +/Subtype /Image +/Height 371 +/Width 874 +/BitsPerComponent 8 +/ColorSpace /DeviceRGB +/Length 24530 +/Filter [/FlateDecode] +/DecodeParms [<< /Predictor 15 +/Colors 3 +/BitsPerComponent 8 +/Columns 874 +>>] +>> +stream +x���y|U�7�NH �%�$0 K�,���̀`8*�03DG� #� ��G�qeD@P!0ddd�Ȓ@ba d���}�筩ꪮ�]�]��}�էN�zNU=]���� From c3c4a1951bc37cd65c850346fbc903e902e49634 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 17:13:53 +0000 Subject: [PATCH 11/12] Remove dupl. module. --- diff --git a/en-US/sysadmin_user_stories/procedure-adding_users_to_user_group.adoc b/en-US/sysadmin_user_stories/procedure-adding_users_to_user_group.adoc deleted file mode 100644 index a94940f..0000000 --- a/en-US/sysadmin_user_stories/procedure-adding_users_to_user_group.adoc +++ /dev/null @@ -1,48 +0,0 @@ -// Include an 'ID' that corresponds to the title of the assembly -// The ID will be used as an anchor for linking to the title -// Do not change the ID to make sure existing links keep working -[#doing_one_task] -= Doing One Task - -_Start the title with a verb form, such as Creating or Create._ - -_A task module is a procedure written with numbered steps -- what a customer needs to do to accomplish a goal successfully._ - -// Ideally, base the name of the file on the title to avoid confusion -// Use a consistent system for filenames and IDs, e.g.: -// * Only substitute spaces with underscores -// * Don't use any CAPS - -This paragraph explains why the user performs the task, sets the context of the task, and may explain or list specical considerations specific to this task. Keep the information brief and focused on what is needed for this specific task. Suggested length is 1 to 3 sentences, can be longer if needed. - -.Prerequisites - -* Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. - -* Delete section title and bullets if the task has no required pre-requisites. - -* Text can be a link to a pre-requisite task that the user must do before starting this task. - - -.Procedure - -_Put steps in a numbered list. The step sequence is important to a repeatable successful outcome._ - -. Start each step with an active verb, because each step corresponds to one user action. - -. Include one command or action per step. - -. Format the step line as an unnumbered bullet if the procedure includes only 1 step (exception to numbering the steps). - -. Include one command or action per step. - -. Include one command or action per step. - - -.Related Information - -* Bulleted list of links to concepts, reference, or other tasks closely related to this task. - -* Include only the most relevant items as links, not every possible related item. - -* Delete section title and bullets if no related information is needed. From 798db4076f336015fdee164f31d398a552e46622 Mon Sep 17 00:00:00 2001 From: Robert Krátký Date: Aug 25 2017 17:19:05 +0000 Subject: [PATCH 12/12] Add module includes & unify mark-up. --- diff --git a/en-US/sysadmin_user_stories/assembly-adding_new_user_accounts.adoc b/en-US/sysadmin_user_stories/assembly-adding_new_user_accounts.adoc index 67b2844..d90789e 100644 --- a/en-US/sysadmin_user_stories/assembly-adding_new_user_accounts.adoc +++ b/en-US/sysadmin_user_stories/assembly-adding_new_user_accounts.adoc @@ -5,7 +5,7 @@ This section describes how you can add a new user account so that another person // Can be adapted from https://bex.fedorapeople.org/fedora-docs-web/f26/system-administrators-guide/basic-system-configuration/Managing_Users_and_Groups.html -== Prerequisites +. Prerequisites * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. diff --git a/en-US/sysadmin_user_stories/assembly-adjusting_file_permissions.adoc b/en-US/sysadmin_user_stories/assembly-adjusting_file_permissions.adoc index 83b0f31..277be64 100644 --- a/en-US/sysadmin_user_stories/assembly-adjusting_file_permissions.adoc +++ b/en-US/sysadmin_user_stories/assembly-adjusting_file_permissions.adoc @@ -5,7 +5,7 @@ This section describes how you can adjust permissions for a file or directory so // Can be adapted from https://bex.fedorapeople.org/fedora-docs-web/f26/system-administrators-guide/basic-system-configuration/Managing_Users_and_Groups.html -== Prerequisites +.Prerequisites * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. diff --git a/en-US/sysadmin_user_stories/assembly-changing_default_database_location.adoc b/en-US/sysadmin_user_stories/assembly-changing_default_database_location.adoc index 115ec4e..0d4fd86 100644 --- a/en-US/sysadmin_user_stories/assembly-changing_default_database_location.adoc +++ b/en-US/sysadmin_user_stories/assembly-changing_default_database_location.adoc @@ -5,7 +5,7 @@ This section describes how you can change the default location for MariaDB. // Can be adapted from 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 -== Prerequisites +.Prerequisites * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. @@ -13,9 +13,9 @@ This section describes how you can change the default location for MariaDB. * Text can be a link to a pre-requisite task that the user must do before starting this task. -// include::concept-.adoc[leveloffset=+1] +include::concept-selinux_and_mariadb_or_postgresql.adoc[leveloffset=+1] -// include::procedure-.adoc[leveloffset=+1] +include::procedure-viewing_selinux_context_of_a_database.adoc[leveloffset=+1] // include::reference-.adoc[leveloffset=+1] diff --git a/en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc b/en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc index 36498b3..2c54d8d 100644 --- a/en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc +++ b/en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc @@ -1,13 +1,26 @@ -// Include an 'ID' that corresponds to the title of the assembly -// The ID will be used as an anchor for linking to the title -// Do not change the ID to make sure existing links keep working -[#doing_configuring_password_policies] +[#configuring_password_policies] = Configuring Password Policies This section describes how to configure a password policy for a user. -include::en-US/sysadmin_user_stories/procedure-setting_password.adoc[leveloffset=+1] +.Prerequisites -include::en-US/sysadmin_user_stories/procedure-enabling_password_aging.adoc[leveloffset=+1] +* Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. -include::en-US/sysadmin_user_stories/reference-chage_command_line_options.adoc[leveloffset=+1] +* Delete section title and bullets if the task has no required pre-requisites. + +* Text can be a link to a pre-requisite task that the user must do before starting this task. + +include::procedure-setting_password.adoc[leveloffset=+1] + +include::procedure-enabling_password_aging.adoc[leveloffset=+1] + +include::reference-chage_command_line_options.adoc[leveloffset=+1] + +== Additional Resources + +* Bulleted list of links to concepts, reference, or other tasks closely related to this user story. + +* Include only the most relevant items as links, not every possible related item. + +* Delete section title and bullets if no related information is needed. diff --git a/en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc b/en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc index 8c35ed2..70d79c9 100644 --- a/en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc +++ b/en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc @@ -1,8 +1,5 @@ -// Include an 'ID' that corresponds to the title of the assembly -// The ID will be used as an anchor for linking to the title -// Do not change the ID to make sure existing links keep working -[#doing_several_tasks_in_sequence] -= Doing Several Tasks in Sequence +[#creating_group_directories] += Creating Group Directories _Start the title with a verb in the gerund form, such as Creating or Configuring._ @@ -23,19 +20,15 @@ This paragraph explains what the user will accomplish by working through the tas * Text can be a link to a pre-requisite task that the user must do before starting this task. -.Procedure +include::procedure-creating_a_directory.adoc[leveloffset=+1] -_Can link to or include task modules, depending on the writer's choice based on information needs. If you link to task modules, add each link as 1 step in a numbered list. The order of included task modules or of the linked steps is important to a repeatable successful outcome. Following is an example of linking to task modules in numbered steps._ +include::procedure-creating_a_user_group.adoc[leveloffset=+1] -. Link to 1st task to perform. +include::procedure-chown_chmod_on_directory_for_user_group.adoc[leveloffset=+1] -. Format the step line as an unnumbered bullet if the procedure includes only 1 step (exception to numbering the steps). +include::procedure-adding_users_to_user_groups.adoc[leveloffset=+1] -. Link to 3rd task to perform. - -. Link to the Nth task to perform. - -.Related Information +== Additional Resources * Bulleted list of links to concepts, reference, or other tasks closely related to this user story. diff --git a/en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc b/en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc index c40725a..5c4d259 100644 --- a/en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc +++ b/en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc @@ -3,7 +3,7 @@ This section describes how you can verify what the permissions for a directory are file so that you can make sure which user or user group can access which files or directories. You can also verify what files or directories can you access. -== Prerequisites +.Prerequisites * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this task. @@ -11,7 +11,7 @@ This section describes how you can verify what the permissions for a directory a * Text can be a link to a pre-requisite task that the user must do before starting this task. -include::.procedure-navigating_to_a_file_or_a_directory.adoc[leveloffset=+1] +include::procedure-navigating_to_a_file_or_a_directory.adoc[leveloffset=+1] include::procedure-listing_files_in_a_directory.adoc[leveloffset=+1]