From e9e888be20ec99e99f919bbee14a42a585a0df44 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Fri, 28 Jun 2024 11:09:40 +0200 Subject: [PATCH 01/13] Update grammar.adoc with guidance on inanimate users See Issue #466 --- .../style_guidelines/grammar.adoc | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 9ac75872..1f4f433c 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -128,4 +128,29 @@ Avoid long introductions and unnecessary context. Shorten unnecessarily long sen === Principle 5: Error recovery, verification, and troubleshooting Recognize that people make mistakes and need to verify that they have completed a task. Be sure to include troubleshooting, error recovery, and verification steps. +[[users]] +== Users +In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. We should use animate personal pronouns such as "who". + +However, in certain technical cases, we sometimes refer to "users" that are not persons but instead user accounts or more abstract concepts. For example, Linux users such as root and guest do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. + +In these specific cases, and only if you cannot write around it, you can refer to these inanimate users with inanimate personal pronouns such as "that". + +.Examples +* Animate user ++ +image:images/no.png[yes] A _user who_ creates a file is the owner of that file. ++ +image:images/yes.png[yes] _Users who_ want to install their own packages... ++ +image:images/no.png[no] Experienced _users that_ can configure their own systems... + +* Inanimate user ++ +image:images/yes.png[yes] Specify a _user that_ is allowed to perform the requested action. ++ +image:images/yes.png[yes] A Linux user has the restrictions of the _SELinux user_ to _which_ it is assigned. ++ +image:images/no.png[no] A Linux user has the restrictions of the _SELinux user_ to _whom_ it is assigned. + // TODO: Add new style entries alphabetically in this file From 815ebd119908a0e4d352afc3713f578a2e305c41 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 23 Jul 2024 09:55:14 +0200 Subject: [PATCH 02/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Andrea Hoffer --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 1f4f433c..02c35915 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -130,7 +130,7 @@ Recognize that people make mistakes and need to verify that they have completed [[users]] == Users -In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. We should use animate personal pronouns such as "who". +In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. In these cases, use animate personal pronouns such as "who". However, in certain technical cases, we sometimes refer to "users" that are not persons but instead user accounts or more abstract concepts. For example, Linux users such as root and guest do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. From 408ce1df026f514ed8291a963932a9875e59b7aa Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 23 Jul 2024 09:55:23 +0200 Subject: [PATCH 03/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Andrea Hoffer --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 02c35915..a8568823 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -132,7 +132,7 @@ Recognize that people make mistakes and need to verify that they have completed == Users In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. In these cases, use animate personal pronouns such as "who". -However, in certain technical cases, we sometimes refer to "users" that are not persons but instead user accounts or more abstract concepts. For example, Linux users such as root and guest do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. +However, in certain technical cases, these users are not persons but instead user accounts or more abstract concepts. For example, Linux users such as root and guest do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. In these specific cases, and only if you cannot write around it, you can refer to these inanimate users with inanimate personal pronouns such as "that". From c5b3a934e05b4cecab1e18fc998495d9e8e08c37 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 23 Jul 2024 10:01:08 +0200 Subject: [PATCH 04/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Nice improvement, thanks! Co-authored-by: Andrea Hoffer --- supplementary_style_guide/style_guidelines/grammar.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index a8568823..fc16103f 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -149,7 +149,9 @@ image:images/no.png[no] Experienced _users that_ can configure their own systems + image:images/yes.png[yes] Specify a _user that_ is allowed to perform the requested action. + -image:images/yes.png[yes] A Linux user has the restrictions of the _SELinux user_ to _which_ it is assigned. +image:images/no.png[no] A Linux user has the restrictions of the _SELinux user who_ it is assigned to. + +image:images/yes.png[yes] A Linux user has the restrictions of the _SELinux user that_ it is assigned to. + image:images/no.png[no] A Linux user has the restrictions of the _SELinux user_ to _whom_ it is assigned. From 5d1965822d7021af40bedc0b54478554f214f5f0 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 23 Jul 2024 11:32:26 +0200 Subject: [PATCH 05/13] Update supplementary_style_guide/style_guidelines/grammar.adoc --- supplementary_style_guide/style_guidelines/grammar.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index fc16103f..39aa1cfc 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -139,7 +139,6 @@ In these specific cases, and only if you cannot write around it, you can refer t .Examples * Animate user + -image:images/no.png[yes] A _user who_ creates a file is the owner of that file. + image:images/yes.png[yes] _Users who_ want to install their own packages... + From 7c32e1f79ba5ec4748d0fa70231da13d9f193762 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 23 Jul 2024 11:36:00 +0200 Subject: [PATCH 06/13] Reorder examples for users --- .../style_guidelines/grammar.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 39aa1cfc..8160b8d9 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -139,19 +139,19 @@ In these specific cases, and only if you cannot write around it, you can refer t .Examples * Animate user + +image:images/no.png[no] Experienced _users that_ can configure their own systems... + image:images/yes.png[yes] _Users who_ want to install their own packages... -+ -image:images/no.png[no] Experienced _users that_ can configure their own systems... * Inanimate user + -image:images/yes.png[yes] Specify a _user that_ is allowed to perform the requested action. -+ image:images/no.png[no] A Linux user has the restrictions of the _SELinux user who_ it is assigned to. - -image:images/yes.png[yes] A Linux user has the restrictions of the _SELinux user that_ it is assigned to. + image:images/no.png[no] A Linux user has the restrictions of the _SELinux user_ to _whom_ it is assigned. ++ +image:images/yes.png[yes] Specify a _user that_ is allowed to perform the requested action. ++ +image:images/yes.png[yes] A Linux user has the restrictions of the _SELinux user that_ it is assigned to. + // TODO: Add new style entries alphabetically in this file From 550cbc7eb1dc8d6f7d8edda3ee87ee00923c96c1 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:02:37 +0200 Subject: [PATCH 07/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Darragh Fitzmaurice <57954076+dfitzmau@users.noreply.github.com> --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 8160b8d9..b8adf3e2 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -132,7 +132,7 @@ Recognize that people make mistakes and need to verify that they have completed == Users In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. In these cases, use animate personal pronouns such as "who". -However, in certain technical cases, these users are not persons but instead user accounts or more abstract concepts. For example, Linux users such as root and guest do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. +However, in certain technical cases, these users are not persons but instead user accounts or more abstract concepts. For example, Linux users such as `root` and `guest` do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. In these specific cases, and only if you cannot write around it, you can refer to these inanimate users with inanimate personal pronouns such as "that". From cceea76151f62c32716a83424115be3ab0305505 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:02:59 +0200 Subject: [PATCH 08/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Darragh Fitzmaurice <57954076+dfitzmau@users.noreply.github.com> --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index b8adf3e2..c9d9d4b2 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -139,7 +139,7 @@ In these specific cases, and only if you cannot write around it, you can refer t .Examples * Animate user + -image:images/no.png[no] Experienced _users that_ can configure their own systems... +image:images/no.png[no] Experienced _users that_ can configure their own systems.... + image:images/yes.png[yes] _Users who_ want to install their own packages... From 6ecce6167cde7680b5af6e6d34e8d39f6d114780 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:03:27 +0200 Subject: [PATCH 09/13] Update supplementary_style_guide/style_guidelines/grammar.adoc --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index c9d9d4b2..3af32b9e 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -141,7 +141,7 @@ In these specific cases, and only if you cannot write around it, you can refer t + image:images/no.png[no] Experienced _users that_ can configure their own systems.... + -image:images/yes.png[yes] _Users who_ want to install their own packages... +image:images/yes.png[yes] _Users who_ want to install their own packages.... * Inanimate user + From ab68a3be09183a775a0119ecb748d0b9695a55f7 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Mon, 29 Jul 2024 12:07:03 +0200 Subject: [PATCH 10/13] Update supplementary_style_guide/style_guidelines/grammar.adoc --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index 3af32b9e..d41273cb 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -132,7 +132,7 @@ Recognize that people make mistakes and need to verify that they have completed == Users In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. In these cases, use animate personal pronouns such as "who". -However, in certain technical cases, these users are not persons but instead user accounts or more abstract concepts. For example, Linux users such as `root` and `guest` do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. +In certain technical cases, these users are not persons but instead user accounts or more abstract concepts (inanimate). For example, Linux `root` and `guest` users do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. In these specific cases, refer to these inanimate users with inanimate personal pronouns such as "that". In these specific cases, and only if you cannot write around it, you can refer to these inanimate users with inanimate personal pronouns such as "that". From 49a4b82650067fbc78ba7a11f4d028cf77aa9b8b Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Mon, 29 Jul 2024 13:22:23 +0200 Subject: [PATCH 11/13] Update supplementary_style_guide/style_guidelines/grammar.adoc --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index d41273cb..f4827beb 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -132,7 +132,7 @@ Recognize that people make mistakes and need to verify that they have completed == Users In most cases, the word "user" refers to a person or a person's user account, and therefore would be considered animate. In these cases, use animate personal pronouns such as "who". -In certain technical cases, these users are not persons but instead user accounts or more abstract concepts (inanimate). For example, Linux `root` and `guest` users do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. In these specific cases, refer to these inanimate users with inanimate personal pronouns such as "that". +In certain technical cases, these users are not persons but instead system accounts or more abstract concepts (inanimate). For example, Linux `root` and `guest` users do not relate to any person. Applications and services might run as specific Linux users with no person controlling them. SELinux users such as `user_u` or `sysadm_u` are identifiers of one or multiple Linux users for access control purposes. In these specific cases, refer to these inanimate users with inanimate personal pronouns such as "that". In these specific cases, and only if you cannot write around it, you can refer to these inanimate users with inanimate personal pronouns such as "that". From 2b04791e069e756bc54406347520ac344117d135 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 6 Aug 2024 10:17:53 +0200 Subject: [PATCH 12/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Andrea Hoffer --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index f4827beb..e03b726e 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -139,7 +139,7 @@ In these specific cases, and only if you cannot write around it, you can refer t .Examples * Animate user + -image:images/no.png[no] Experienced _users that_ can configure their own systems.... +image:images/no.png[no] Experienced _users that_ can configure their own systems... + image:images/yes.png[yes] _Users who_ want to install their own packages.... From 44563258a819434c3bbcf3055afa27e639a71269 Mon Sep 17 00:00:00 2001 From: jafiala <56597272+jafiala@users.noreply.github.com> Date: Tue, 6 Aug 2024 10:18:02 +0200 Subject: [PATCH 13/13] Update supplementary_style_guide/style_guidelines/grammar.adoc Co-authored-by: Andrea Hoffer --- supplementary_style_guide/style_guidelines/grammar.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/supplementary_style_guide/style_guidelines/grammar.adoc b/supplementary_style_guide/style_guidelines/grammar.adoc index e03b726e..0b3ec3b8 100644 --- a/supplementary_style_guide/style_guidelines/grammar.adoc +++ b/supplementary_style_guide/style_guidelines/grammar.adoc @@ -141,7 +141,7 @@ In these specific cases, and only if you cannot write around it, you can refer t + image:images/no.png[no] Experienced _users that_ can configure their own systems... + -image:images/yes.png[yes] _Users who_ want to install their own packages.... +image:images/yes.png[yes] _Users who_ want to install their own packages... * Inanimate user +