PR#9: A few tweaks for consistency - fedora-docs/flock2017-docs-workshop

		`@@ -5,14 +5,6 @@`

		`// Can be adapted from https://bex.fedorapeople.org/fedora-docs-web/f26/system-administrators-guide/basic-system-configuration/Managing_Users_and_Groups.html`

		`- . 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.`
		`-`
		`include::concept-what_is_a_user.adoc[leveloffset=+1]`

		`include::concept-what_is_a_group.adoc[leveloffset=+1]`
		`@@ -21,7 +13,7 @@`

		`include::procedure-useradd.adoc[leveloffset=+1]`

		`- include::procedure-groupadd.adoc[leveloffset=+1]`
		`+ include::procedure-creating_a_user_group.adoc[leveloffset=+1]`

		`include::procedure-adding_users_to_user_groups.adoc[leveloffset=+1]`

en-US/sysadmin_user_stories/assembly-configuring_password_policies_for_users.adoc

file modified

+1 -1

		`@@ -5,7 +5,7 @@`

		`.Prerequisites`

		`- * User account created.`
		`+ * User account created. See <<adding-a-new-user-account>>.`

		`include::procedure-setting_passwords.adoc[leveloffset=+1]`

en-US/sysadmin_user_stories/assembly-creating_group_directories.adoc

file modified

+7 -41

		`@@ -1,16 +1,12 @@`
		`[#creating_group_directories]`
		`= Creating Group Directories`

		`- _Start the title with a verb in the gerund form, such as Creating or Configuring._`
		`-`
		`// 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`

		`- _Use this template to document a user story -- any series of tasks that the user must perform in a specific order to accomplish something._`
		`-`
		`- This paragraph explains what the user will accomplish by working through the tasks in sequence. It sets context or explains the benefit the user will gain by performing the tasks that comprise the story. May include more than 1 paragraph, and may include concept modules if needed to fully explain the context, benefits, and other things the user must understand to complete the tasks successfully.`
		`+ This section describes how to create a shared directory accessible only to members of a specific user group.`

		`.Prerequisites`

		`@@ -20,46 +16,16 @@`

		`* Text can be a link to a pre-requisite task that the user must do before starting this task.`

		`- // prerequisite`
		`- include::concept-what_is_a_user.adoc[leveloffset+1]`
		`-`
		`- // prerequisite`
		`- include::concept-what_is_a_group.adoc[leveloffset+1]`
		`-`
		`- .Procedure`
		`-`
		`- This section describes how to create a shared directory accessible only to members of a specific user group.`
		`-`
		`- * 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.`
		`-`
		`- // Create a user group.`
		`- // include::en-US/sysadmin_user_stories/procedure-creating_a_user_group.adoc[leveloffset+1]`
		`include::procedure-creating_a_user_group.adoc[leveloffset+1]`
		`- +`
		`- // Add the new user to the group.`
		`- // include::en-US/sysadmin_user_stories/procedure-adding_users_to_user_groups.adoc[leveloffset+1]`
		`- include::procedure-adding_users_to_user_groups.adoc[leveloffset+1]`
		`- +`
		`- // Creating a directory`
		`- // include::en-US/sysadmin_user_stories/procedure-creating_a_directory.adoc[leveloffset+1]`
		`- include::procedure-creating_a_directory.adoc[leveloffset+1]`
		`- +`
		`- // Changing ownership of a directory to a user group.`
		`- // include::en-US/sysadmin_user_stories/procedure-chown_chmod_on_director_for_user_group.adoc[leveloffset+1]`
		`- include::procedure-chown_chmod_on_directory_for_user_group.adoc[leveloffset+1]`
		`-`
		`- == Additional Resources`

		`- * Bulleted list of links to concepts, reference, or other tasks closely related to this user story.`
		`+ include::procedure-adding_users_to_user_groups.adoc[leveloffset+1]`

		`- * Include only the most relevant items as links, not every possible related item.`
		`+ include::procedure-creating_a_directory.adoc[leveloffset+1]`

		`- * Delete section title and bullets if no related information is needed.`
		`+ include::procedure-chown_chmod_on_directory_for_user_group.adoc[leveloffset+1]`

		`include::reference-useradd_command_line_options.adoc[leveloffset=+1]`

		`- include::reference-useradd_command_line_options.adoc[leveloffset=+1]`
		`+ == Additional Resources`
		`+`
		`+ * For details on groups, see <<what_is_a_group>>.`

en-US/sysadmin_user_stories/assembly-verifying_file_permissions.adoc

file modified

+1 -1

		`@@ -1,7 +1,7 @@`
		`[#verifying-file-permissions]`
		`= Verifying File Permissions`

		`- 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.`
		`+ 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 you can access.`

		`.Prerequisites`

en-US/sysadmin_user_stories/concept-selinux_and_mariadb_or_postgresql.adoc

file modified

+3 -3

		`@@ -11,12 +11,12 @@`
		`// * Only substitute spaces with underscores`
		`// * Don't use any CAPS`

		`- A concept module describes and explains things such as a product, subsystem, or feature -- what a customer needs to understand to do a task. A concept module may also explain how things relate and interact with other things. The use of graphics and diagrams can speed up understanding of a concept.`
		`+ A concept module describes and explains things such as a product, subsystem, or feature -- what a user needs to understand to do a procedure. A concept module may also explain how things relate and interact with other things. The use of graphics and diagrams can speed up understanding of a concept.`

		`- * Look at nouns and noun phrases in related task modules and user story assemblies to find the concepts to explain to users.`
		`+ * Look at nouns and noun phrases in related procedure modules and user story assemblies to find the concepts to explain to users.`

		`* A concept module in product documentation should explain only things that are visible to users.`

		`* If a product concept is interesting, but not visible to users, the concept probably does not require explanation in a concept module.`

		`- * A concept module should NOT include numbered steps or other wording that instructs a user to execute a command or perform an action. Instead, put that information in a separate task module or user story assembly.`
		`+ * A concept module should NOT include numbered steps or other wording that instructs a user to execute a command or perform an action. Instead, put that information in a separate procedure module or user story assembly.`

en-US/sysadmin_user_stories/concept-what_happens_when_a_new_user_is_created.adoc

file modified

+3 -3

		`@@ -11,12 +11,12 @@`
		`// * Only substitute spaces with underscores`
		`// * Don't use any CAPS`

		`- A concept module describes and explains things such as a product, subsystem, or feature -- what a customer needs to understand to do a task. A concept module may also explain how things relate and interact with other things. The use of graphics and diagrams can speed up understanding of a concept.`
		`+ A concept module describes and explains things such as a product, subsystem, or feature -- what a user needs to understand to do a procedure. A concept module may also explain how things relate and interact with other things. The use of graphics and diagrams can speed up understanding of a concept.`

		`- * Look at nouns and noun phrases in related task modules and user story assemblies to find the concepts to explain to users.`
		`+ * Look at nouns and noun phrases in related procedure modules and user story assemblies to find the concepts to explain to users.`

		`* A concept module in product documentation should explain only things that are visible to users.`

		`* If a product concept is interesting, but not visible to users, the concept probably does not require explanation in a concept module.`

		`- * A concept module should NOT include numbered steps or other wording that instructs a user to execute a command or perform an action. Instead, put that information in a separate task module or user story assembly.`
		`+ * A concept module should NOT include numbered steps or other wording that instructs a user to execute a command or perform an action. Instead, put that information in a separate procedure module or user story assembly.`

en-US/sysadmin_user_stories/concept-what_is_a_group.adoc

file modified

+1 -1

		`@@ -5,7 +5,7 @@`
		`// locally defined replaceable`
		`:MAJOROS: Fedora`

		`- [#concept_what_is_a_user]`
		`+ [#what_is_a_group]`
		`= What Is a Group?`

		`// Ideally, base the name of the file on the title to avoid confusion`

en-US/sysadmin_user_stories/procedure-adding_users_to_user_groups.adoc

file modified

		`@@ -2,6 +2,11 @@`
		`// 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`
		`[#adding_users_to_user_groups]`
		`+ = Adding Users to User Groups`
		`+`
		+ This procedure describes how to add a user to a user group with the `usermod` command.
		`+`
		`+ .Procedure`

		`. Add users to the your new user group:`
		`+`

en-US/sysadmin_user_stories/procedure-changing_file_permissions.adoc

file modified

+8 -8

		`@@ -1,27 +1,27 @@`
		`// 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`
		`+ [#doing_one_procedure]`
		`+ = Doing One Procedure`

		`_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._`
		`+ _A procedure module is a procedure written with numbered steps -- what a user 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.`
		`+ This paragraph explains why the user performs the procedure, sets the context of the procedure, and may explain or list specical considerations specific to this procedure. Keep the information brief and focused on what is needed for this specific procedure. 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.`
		`+ * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this procedure.`

		`- * Delete section title and bullets if the task has no required pre-requisites.`
		`+ * Delete section title and bullets if the procedure has no required pre-requisites.`

		`- * Text can be a link to a pre-requisite task that the user must do before starting this task.`
		`+ * Text can be a link to a pre-requisite module that the user must do before starting this module.`


		`.Procedure`
		`@@ -41,7 +41,7 @@`

		`.Related Information`

		`- * Bulleted list of links to concepts, reference, or other tasks closely related to this task.`
		`+ * Bulleted list of links to concepts, reference, or other procedures closely related to this module.`

		`* Include only the most relevant items as links, not every possible related item.`

en-US/sysadmin_user_stories/procedure-chown_chmod_on_directory_for_user_group.adoc

file modified

+9 -3

		`@@ -1,7 +1,13 @@`
		`// 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`
		`- [#chmod_chown_on_directory_for_user_group]`
		`+ [#using_chown_and_chmod_on_a_directory_for_a_user_group]`
		+ = Using `chown` and `chmod` on a Directory for a User Group
		`+`
		`+ This procedure describes how to ensure that all members of a group can create and edit files in a directory.`
		`+`
		`+ .Procedure`
		`+`
		. Associate the contents of the `/opt/myproject/` directory with the `myproject` group:
		`+`
		`[subs="quotes, macros"]`
		`@@ -14,9 +20,9 @@`
		`----`
		`[command]#chmod 2775 /opt/myproject#`
		`----`
		`- +`
		`+`
		At this point, all members of the `myproject` group can create and edit files in the `/opt/myproject/` directory without the administrator having to change file permissions every time users write new files. To verify that the permissions have been set correctly, run the following command:
		`- +`
		`+`
		`[subs="attributes"]`
		`----`
		`~]#{nbsp}ls -ld /opt/myproject`

en-US/sysadmin_user_stories/procedure-creating_a_directory.adoc

file modified

+6 -1

		`@@ -1,7 +1,12 @@`
		`// 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]`
		`+ [#creating_a_directory]`
		`+ = Creating a Directory`
		`+`
		+ The `mkdir` command creates a directory.
		`+`
		`+ .Procedure`

		. As `root`, create the `/opt/myproject/` directory by typing the following at a shell prompt:
		`+`

en-US/sysadmin_user_stories/procedure-creating_a_user_group.adoc

file modified

		`@@ -2,6 +2,12 @@`
		`// 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`
		`[#creating_a_user_group]`
		`+ = Creating a User Group`
		`+`
		+ This procedure describes how to create a group with the `groupadd` command.
		`+`
		`+ .Procedure`
		`+`
		. Create the `myproject` group by typing the following at a shell prompt as `root`:
		`+`
		`[subs="macros,quotes"]`

en-US/sysadmin_user_stories/procedure-groupadd.adoc

file removed

-48

		`@@ -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.`

en-US/sysadmin_user_stories/procedure-listing_files_in_a_directory.adoc

file modified

+8 -8

		`@@ -1,27 +1,27 @@`
		`// 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`
		`+ [#doing_one_procedure]`
		`+ = Doing One Procedure`

		`_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._`
		`+ _A procedure module is a procedure written with numbered steps -- what a user 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.`
		`+ This paragraph explains why the user performs the procedure, sets the context of the procedure, and may explain or list specical considerations specific to this procedure. Keep the information brief and focused on what is needed for this specific procedure. 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.`
		`+ * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this procedure.`

		`- * Delete section title and bullets if the task has no required pre-requisites.`
		`+ * Delete section title and bullets if the procedure has no required pre-requisites.`

		`- * Text can be a link to a pre-requisite task that the user must do before starting this task.`
		`+ * Text can be a link to a pre-requisite module that the user must do before starting this module.`


		`.Procedure`
		`@@ -41,7 +41,7 @@`

		`.Related Information`

		`- * Bulleted list of links to concepts, reference, or other tasks closely related to this task.`
		`+ * Bulleted list of links to concepts, reference, or other procedures closely related to this module.`

		`* Include only the most relevant items as links, not every possible related item.`

en-US/sysadmin_user_stories/procedure-navigating_to_a_file_or_a_directory.adoc

file modified

+8 -8

		`@@ -1,27 +1,27 @@`
		`// 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`
		`+ [#doing_one_procedure]`
		`+ = Doing One Procedure`

		`_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._`
		`+ _A procedure module is a procedure written with numbered steps -- what a user 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.`
		`+ This paragraph explains why the user performs the procedure, sets the context of the procedure, and may explain or list specical considerations specific to this procedure. Keep the information brief and focused on what is needed for this specific procedure. 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.`
		`+ * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this procedure.`

		`- * Delete section title and bullets if the task has no required pre-requisites.`
		`+ * Delete section title and bullets if the procedure has no required pre-requisites.`

		`- * Text can be a link to a pre-requisite task that the user must do before starting this task.`
		`+ * Text can be a link to a pre-requisite module that the user must do before starting this module.`


		`.Procedure`
		`@@ -41,7 +41,7 @@`

		`.Related Information`

		`- * Bulleted list of links to concepts, reference, or other tasks closely related to this task.`
		`+ * Bulleted list of links to concepts, reference, or other procedures closely related to this module.`

		`* Include only the most relevant items as links, not every possible related item.`

en-US/sysadmin_user_stories/procedure-useradd.adoc

file modified

+7 -1

		`@@ -2,7 +2,13 @@`
		`// 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`
		`[#adding_a_new_user]`
		- . Add a new user by typing the following at a shell prompt as `root`:
		`+ = Adding a New User`
		`+`
		+ This procedure describes how to create a new user with the `useradd` command.
		`+`
		`+ .Procedure`
		`+`
		+ . Add a new user by typing the following at a shell prompt as `root`:
		`+`
		`[subs="quotes, macros"]`
		`----`

en-US/sysadmin_user_stories/procedure-viewing_selinux_context_of_a_database.adoc

file modified

+8 -8

		`@@ -1,27 +1,27 @@`
		`// 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`
		`+ [#doing_one_procedure]`
		`+ = Doing One Procedure`

		`_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._`
		`+ _A procedure module is a procedure written with numbered steps -- what a user 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.`
		`+ This paragraph explains why the user performs the procedure, sets the context of the procedure, and may explain or list specical considerations specific to this procedure. Keep the information brief and focused on what is needed for this specific procedure. 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.`
		`+ * Sentence or a bulleted list of pre-requisites that must be in place or done before the user starts this procedure.`

		`- * Delete section title and bullets if the task has no required pre-requisites.`
		`+ * Delete section title and bullets if the procedure has no required pre-requisites.`

		`- * Text can be a link to a pre-requisite task that the user must do before starting this task.`
		`+ * Text can be a link to a pre-requisite module that the user must do before starting this module.`


		`.Procedure`
		`@@ -41,7 +41,7 @@`

		`.Related Information`

		`- * Bulleted list of links to concepts, reference, or other tasks closely related to this task.`
		`+ * Bulleted list of links to concepts, reference, or other procedures closely related to this module.`

		`* Include only the most relevant items as links, not every possible related item.`

en-US/sysadmin_user_stories/reference-permission_types.adoc

file modified

+1 -1

		`@@ -11,7 +11,7 @@`
		`// * Only substitute spaces with underscores`
		`// * Don't use any CAPS`

		`- A reference module lists things (such as a list of commands) or has a very regimented structure (such as the consistent structure of man pages). A reference module explains the details that a customer needs to know to do a task. A reference module is well-organized if users can scan it to quickly find the details they want.`
		`+ A reference module lists things (such as a list of commands) or has a very regimented structure (such as the consistent structure of man pages). A reference module explains the details that a user needs to know to do a task. A reference module is well-organized if users can scan it to quickly find the details they want.`

		`* A reference module that is a list of things may be made easier to scan if its content is organized alphabetically or formatted as a table. Think of an alphabetical list of commands that can be used with an application, or of an alphabetical list of system components with brief definitions formatted as a 2-column table.`

en-US/sysadmin_user_stories/reference-useradd_command_line_options.adoc

file modified

+4 -2

		`@@ -1,6 +1,8 @@`
		`- [[table-useradd-options]]`
		`+ [#common_useradd_command-line_options]`
		+ = Common `useradd` Command-line Options

		`- .Common useradd command-line options`
		`+ [[table-useradd-options]]`
		+ .Common `useradd` command-line options
		`[options="header"]`
		`\|===`
		`\|Option\|Description`

no initial comment

aneta commented 6 years ago

@rkratky Can you please look at this? I fixed the things we talked about, but I'm not sure if it's okay that we have duplicate IDs. They were there before, but I just want to be sure.