Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update grammar.adoc with guidance on inanimate users #495

Merged

Conversation

jafiala
Copy link
Contributor

@jafiala jafiala commented Jun 28, 2024

See Issue #466

@jafiala jafiala mentioned this pull request Jun 28, 2024
@bergerhoffer bergerhoffer added the Style guideline Topics that add or modify style guidelines label Jul 3, 2024
Copy link
Collaborator

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few initial thoughts

supplementary_style_guide/style_guidelines/grammar.adoc Outdated Show resolved Hide resolved
== 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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. 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".

supplementary_style_guide/style_guidelines/grammar.adoc Outdated Show resolved Hide resolved
Copy link

@snarayan-redhat snarayan-redhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Left some thoughts.

Comment on lines +148 to +154
image:images/no.png[no] A Linux user has the restrictions of the _SELinux user who_ 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... it is assigned to. Here it is inanimate and I believe it is referring to A Linux user. But IIUC, Linux user is still animate here, in which case we might have to say ..they are assigned to. instead. Feel free to correct me here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the Linux user here does not refer to a person who uses linux, but to the Linux user account, like guest.

Copy link

@snarayan-redhat snarayan-redhat Jul 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so we may want to emphasize on that too since it is overlooked currently.
e.g.
image:images/no.png[no] A _Linux user_ has the restrictions of the _SELinux user who it is_ assigned to.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I tried to emphasize only the parts of speech to which the pronouns point (and the pronouns themselves). I think emphasizing this user would make it less clear, because no pronoun refers to it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... it is assigned to. Here it is inanimate and I believe it is referring to A Linux user. But IIUC, Linux user is still animate here, in which case we might have to say ..they are assigned to. instead. Feel free to correct me here.

I thought it refers to Linux user

@@ -128,4 +128,30 @@ 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. In these cases, use animate personal pronouns such as "who".

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking out aloud here. Do we want to differentiate them like the "task performer" vs "role references"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I'm not sure I understand what you mean here.

Do you mean that we sometimes refer to "users" as those who perform the tasks (i.e. reader)?

And Linux and SELinux users and similar would be role references?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was trying to suggest some direct guidelines that would help writers make a decision. I was thinking something on the lines of:
"Task performers" -> Use animate
"Role references"-> Use inanimate

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've thought about this, but I think this is too simple a recommendation. We can refer to personal users even when they are not task performers. In fact, we should typically refer to task performers as "you" and write directly to them.

Also, we should primarily write around role references instead of using the inanimate pronouns.

So I think the current recommendation is more accurate:

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".

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good!

dfitzmau
dfitzmau previously approved these changes Jul 31, 2024
Copy link
Collaborator

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor things, otherwise lgtm

supplementary_style_guide/style_guidelines/grammar.adoc Outdated Show resolved Hide resolved
supplementary_style_guide/style_guidelines/grammar.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@bburt-rh bburt-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@bburt-rh
Copy link
Contributor

bburt-rh commented Aug 7, 2024

Three approvals. Merging

@bburt-rh bburt-rh merged commit 6ef5bf3 into redhat-documentation:main Aug 7, 2024
1 check passed
@jafiala jafiala deleted the The-personhood-of-users-#466 branch August 8, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Style guideline Topics that add or modify style guidelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants