From 4ae8ea563c40f84d5e095ae186c9d2dea35b322e Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Mon, 31 Oct 2022 11:36:27 -0700 Subject: [PATCH] Mention personal access token variables in the style guide (#32025) Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- contributing/content-style-guide.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 368d299d1d..e621358568 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -446,6 +446,21 @@ Always use "dev container" (or, where clarification is needed, its longer form " Use "development container configuration files" to refer to all of the files in the `.devcontainer` directory (plus the `.devcontainer.json` if that's being used rather than `devcontainer.json` in the `.devcontainer` directory). Don't refer to these as "development container files" or "devcontainer files" to avoid this being taken as referring to `devcontainer.json` files. "Development container configuration files" refers to all of the files that can be used to configure a dev container, including `Dockerfile` and `docker-compose.yml` files. Don't use "the development container configuration file" (singular) when referring specifically to a `devcontainer.json` file. Instead refer to this file by its name. +### Personal access tokens + +GitHub has two types of personal access tokens: + +- Fine-grained personal access tokens: Offer granular control over repository access and permissions +- Personal access tokens (classic): Use scopes and grant access to all repositories that the token owner can access + +You should use variables to refer to these types of tokens, as well as to personal access tokens in general: + +- Use `{% data variables.product.pat_generic %}` or `{% data variables.product.pat_generic_caps %}` to refer to personal access tokens in general. +- Use `{% data variables.product.pat_v2 %}` or `{% data variables.product.pat_v2_caps %}` to refer to fine-grained personal access tokens. +- Use `{% data variables.product.pat_v1 %}`, `{% data variables.product.pat_v1_plural %}`, `{% data variables.product.pat_v1_caps %}`, or `{% data variables.product.pat_v1_caps_plural %}` to refer to personal access tokens (classic). + +For more information about GitHub's personal access tokens, see "[Creating a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#about-personal-access-tokens)." + ## Punctuation Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.