Clarify inbound token / allowlist functionality
What does this MR do?
In Slack, even people very close to this change were still confused about the wording here.
I made the following changes:
- Removed
Control your project's job token scope
– I believe this to be incorrect, as the setting does not change anything about the job token scope of the project on which you're editing the allowlist. It changes what the job tokens of other projects can do. - Replaced
its
withtheir
, because we are referring to multipleprojects
earlier in the sentence. - In the
For example
sentence, I changed the order of project A and project B. While it is grammatically not as clean anymore, I think this is an okay tradeoff to avoid the reader having to juggle "why is something that is universally seen as option number 2 mentioned before option number 1" in their mind while parsing the entire example. - Moved the
"allowed project"
term into brackets, as it was an additional thing you had to keep in mind/parse while trying to understand the example. Seeing project B first and then being told that it can be referred to differently is easier to grok than seeing a new term and then learning what the new term refers to. - Replaced
your current project
with something that feels more specific and less open to misinterpretation to me.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Manuel Grabowski