Skip to content

Commit

Permalink
Merge branch 'main' into seemless-typo
Browse files Browse the repository at this point in the history
  • Loading branch information
mchammer01 authored Oct 27, 2023
2 parents 4d909dd + 9fce889 commit 3a0dfc6
Show file tree
Hide file tree
Showing 19 changed files with 424 additions and 159 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=

Uploads a SARIF file to GitHub code scanning.

See:
<https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github>
See: [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github).

A GitHub Apps token or personal access token must be set. For best
security practices, it is recommended to set the `--github-auth-stdin`
Expand All @@ -51,8 +50,7 @@ This token must have the `security_events` scope.
\[Mandatory] Path to the SARIF file to upload. This should be the
output of [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) (or [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results)) with `--format sarif-latest` for upload to github.com or
GitHub AE, or the appropriate supported format tag for GitHub Enterprise
Server instances (see <https://docs.github.com/> for the right value for
your release).
Server instances (see [AUTOTITLE](/enterprise-server@latest/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning#sariflog-object) for SARIF versions supported by your release).

#### `-r, --repository=<repository-name>`

Expand Down Expand Up @@ -97,8 +95,7 @@ upload.

`json`: Print the response body of the SARIF upload API request.

See also:
<https://docs.github.com/en/rest/reference/code-scanning#upload-an-analysis-as-sarif-data>
See also: [AUTOTITLE](/rest/code-scanning/code-scanning?apiVersion=2022-11-28#upload-an-analysis-as-sarif-data).

### Options to configure where to upload SARIF files.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,15 @@ Formatting unordered lists:
- If the order of items in the list is not important, alphabetize the list items.
- If the order is important, then order the list by the importance to the reader (for example, moving from broadest audience and applicability to a more specialized audience).
When introducing a list, avoid phrasing like “the following” or “these”, terms which are difficult to localize. Instead, be descriptive, yet general enough to allow a list to scale or change without having to update the description.
When introducing a list, avoid short, nonspecific sentences using terms like “the following” or “these”, which are difficult to localize without context. Instead, create a descriptive sentence that clearly conveys the subject of the list, yet allows the list to scale or change without having to update the description.
**Use:**
- For an introduction to {% data variables.product.prodname_dotcom %}, see the following articles:
- SMS authentication is supported in these countries:
**Avoid:**
- There are several articles that provide an introduction to {% data variables.product.prodname_dotcom %}. See the following:
- SMS authentication is supported in 50 countries. These include:
## Placeholders
Expand Down
2 changes: 2 additions & 0 deletions content/rest/overview/resources-in-the-rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,8 @@ If you exceed the rate limit, the response will have a `403` status and the `x-r
> }
```
For requests using the Git LFS API (that is, the one used by the Git LFS client), the response will instead have a `429` status.
If you are rate limited, you should not try your request until after the time specified by the `x-ratelimit-reset` time.
### Increasing the unauthenticated rate limit for {% data variables.product.prodname_oauth_apps %}
Expand Down
36 changes: 18 additions & 18 deletions contributing/content-model.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Content model for GitHub Docs

**Note:** This version of the content model is no longer maintained and will be deprecated. See the [style guide](https://docs.github.com/en/contributing/writing-for-github-docs/style-guide) on docs.github.com for the most up to date version. Open any pull requests against the `contributing/writing-for-github-docs/style-guide.md` file.
**Note:** This version of the content model is no longer maintained and will be deprecated. See the [content model](https://docs.github.com/contributing/style-guide-and-content-model/content-model) on docs.github.com for the most up-to-date version. Open any pull requests against the `contributing/style-guide-and-content-model/content-model.md` file.

_Full TOC :arrow_upper_left:_

Expand Down Expand Up @@ -36,7 +36,7 @@ The homepage includes all top-level doc sets and some categories. Content on the

The goal of the homepage is to help people find information about the GitHub feature or product that they want to learn about. Every item on the homepage dilutes the discoverability of every other item, so we limit the number of doc sets included on the homepage.

If a new top-level doc set is created, it is added to the homepage.
If a new top-level doc set is created, it is added to the homepage.

If a category serves as the starting point for using a GitHub product or feature, it can be added to the homepage.

Expand Down Expand Up @@ -71,7 +71,7 @@ Categories are usually organized around a feature or a discrete set of tasks wit
- Examples
- [Setting up and managing your GitHub user account](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account)
- [Installing GitHub Enterprise](https://docs.github.com/en/enterprise-server@3.0/admin/installation)

#### Intros for categories
All categories have intros. Keep the intros one sentence long, and general or high-level enough to scale with future product changes without having to remember to update the intro. If you significantly change a category’s structure, check its intro for needed updates.

Expand Down Expand Up @@ -106,12 +106,12 @@ We organize content predictably within categories, map topics, and articles, fro
- Procedural content on using a feature
- Procedural content on managing a feature or setting
- Procedural content on disabling a feature or setting
- Procedural content on destructive actions (e.g. deletion)
- Procedural content on destructive actions (e.g. deletion)
- Troubleshooting information

### Titles

Titles fully describe what a page is about, and what a user will know by reading it.
Titles fully describe what a page is about, and what a user will know by reading it.

Titles are challenging! Use these general guidelines to help create clear, helpful, and descriptive titles. See below for specific guidelines for each content type.

Expand All @@ -121,7 +121,7 @@ Titles are challenging! Use these general guidelines to help create clear, helpf
- Use: Example of configuring a codespace
- Avoid: Using the workflow editor sidebar
- Avoid: Example
- Titles have hard limits for length to keep them easy to understand (and easier to render on the site):
- Titles have hard limits for length to keep them easy to understand (and easier to render on the site):
- Category titles: 67 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 27 characters
- Map topic titles: 63 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 30 characters
- Article titles: 80 characters, 60 if possible, and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 31 characters, ideally 20-25 characters
Expand Down Expand Up @@ -195,7 +195,7 @@ Conceptual content helps people understand a feature or topic by providing a cle
We create conceptual articles and conceptual sections within other articles. Most major products, features, or subjects have their own conceptual article.

#### How to write conceptual content
Use the [conceptual content template](https://github.com/github/docs/blob/main/contributing/content-templates.md#conceptual) to write a conceptual article.
Use the [conceptual content template](https://github.com/github/docs/blob/main/contributing/content-templates.md#conceptual) to write a conceptual article.

- Describe in plain language what the feature, product, or topic is
- Describe its purpose and why it’s useful to the reader
Expand Down Expand Up @@ -288,11 +288,11 @@ Use the [procedural content template](https://github.com/github/docs/blob/main/c

### Release notes

Release notes enable readers to understand and prepare for the customer-facing changes in each release of GitHub's versioned enterprise products (e.g., GitHub Enterprise Server). Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new GitHub features and functionality.
Release notes enable readers to understand and prepare for the customer-facing changes in each release of GitHub's versioned enterprise products (e.g., GitHub Enterprise Server). Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new GitHub features and functionality.

Writers source, edit, and publish release notes in collaboration with product DRIs, feature owners, and individual engineers at GitHub. For each individual release, we group release notes by predefined types.

We publish the release notes for [GitHub Enterprise Server](https://docs.github.com/enterprise-server/admin/release-notes) (GHES) and [GitHub AE](https://docs.github.com/github-ae@latest/admin/release-notes) (GHAE) on GitHub Docs, in the "Enterprise administrators" documentation set.
We publish the release notes for [GitHub Enterprise Server](https://docs.github.com/enterprise-server/admin/release-notes) (GHES) and [GitHub AE](https://docs.github.com/github-ae@latest/admin/release-notes) (GHAE) on GitHub Docs, in the "Enterprise administrators" documentation set.

#### Types of releases

Expand Down Expand Up @@ -321,7 +321,7 @@ Use known issues to explain the following situations.
- Behavior that regularly prevents the use of the product or feature for a common purpose.
- Rare or severe bugs that GitHub has not yet prioritized fixing, and that are not explained in the product or by existing content on GitHub Docs.

#### How to write troubleshooting content
#### How to write troubleshooting content
- Use any GitHub Docs content type to create troubleshooting sections.
- Whenever possible, keep troubleshooting content contained within procedural content or guides.
- You can create a troubleshooting article when it makes sense to keep it separate, such as when there’s a large amount of troubleshooting content on a particular topic.
Expand Down Expand Up @@ -405,7 +405,7 @@ Tutorials help people learn about products and solve real world problems by guid
Tutorials are useful when someone has a basic understanding of the product and is interested in extending their understanding to solve a specific problem. Tutorials are for people who want expert advice and a detailed discussion of best practices related to their problem. Tutorials also help people who've implemented similar solutions in the past with other products use GitHub. Tutorials can also help people validate whether the solution is appropriate for their needs.

#### How to write a tutorial
Use the [tutorial template](https://github.com/github/docs/blob/main/contributing/content-templates.md#tutorial) to create a tutorial.
Use the [tutorial template](https://github.com/github/docs/blob/main/contributing/content-templates.md#tutorial) to create a tutorial.

Contents of tutorials:
- Introduction
Expand Down Expand Up @@ -481,7 +481,7 @@ Use the product callout when a feature is available in specific products only an
All product callouts are stored as reusables in [`gated-features`](https://github.com/github/docs/tree/main/data/reusables/gated-features) and added in YAML frontmatter for relevant articles.

#### How to write a product callout
- Product callouts follow a strict format, clearly identifying the feature and which products it’s available in.
- Product callouts follow a strict format, clearly identifying the feature and which products it’s available in.
- Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article.
- Examples:
- [Feature name] is available in [product(s)]. For more information, see "GitHub’s products.”
Expand All @@ -502,10 +502,10 @@ The top of every page has an intro that provides context and sets expectations,
- Map topic and category intros are one sentence long.
- API reference intros are one sentence long.
- The intro for an API page should define the feature so that a user knows whether the feature meets their needs without reading the entire article.
- Intros contain a high-level summary of the page’s content, developing the idea presented in a title with more detail.
- Use approachable synonyms of words in the page’s title to help readers understand the article’s purpose differently. Avoid repeating words from the title when possible.
- Intros contain a high-level summary of the page’s content, developing the idea presented in a title with more detail.
- Use approachable synonyms of words in the page’s title to help readers understand the article’s purpose differently. Avoid repeating words from the title when possible.
- Intros are relatively evergreen and high-level, so they can scale with future changes to the content on the page without needing to be frequently updated.
- For searchability, include keywords on the page's subject in the intro.
- For searchability, include keywords on the page's subject in the intro.
- When a term in the intro has an acronym we’ll use elsewhere in the article, indicate the acronym.
- Intros generally don't contain permissions for any tasks contained within the article.

Expand All @@ -516,8 +516,8 @@ Every procedure includes a permissions statement explaining the role required to
Occasionally, it's relevant to mention required permissions in conceptual content, especially in standalone conceptual articles. Make sure to also include a permissions statement in related procedures (or write a longer article combining all of the content).

#### How to write a permissions statement
- When a single set of permissions applies to all procedures in an article, use the [permissions frontmatter](https://github.com/github/docs/tree/main/content#permissions).
- When an article contains multiple procedures and different permissions apply, include a separate permissions statement under each relevant header, before each procedure.
- When a single set of permissions applies to all procedures in an article, use the [permissions frontmatter](https://github.com/github/docs/tree/main/content#permissions).
- When an article contains multiple procedures and different permissions apply, include a separate permissions statement under each relevant header, before each procedure.
- Don't include permissions in an article’s intro.
- Roles exist at different levels. Refer only to the role at the same level as the action. For example, you need admin access to a repository (repository-level role) to configure protected branches. You can get admin access to a repository by being an organization owner (organization-level role), but the repository-level role is what actually governs your ability to take the action, so that is the only role that should be mentioned in the permissions statement.
- Language to use in a permissions statement:
Expand Down Expand Up @@ -573,7 +573,7 @@ Troubleshooting content helps people avoid or work through errors. See "[Trouble
Further reading sections highlight additional targeted articles that aren’t already included within the article’s content or sidebar. Use further reading sections sparingly when they provide real value.

#### How to write a further reading section
- Use a bulleted list.
- Use a bulleted list.
- Use further reading sections sparingly and when they provide high value - see style guide for guidelines on linking.

#### Title and format for further reading sections
Expand Down
2 changes: 1 addition & 1 deletion contributing/content-style-guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Content style guide for GitHub Docs <!-- omit in toc -->

**Note:** This version of the style guide is no longer maintained and will be deprecated. See the [content model](https://docs.github.com/en/contributing/writing-for-github-docs/content-model) on docs.github.com for the most up to date version. Open any pull requests against the `contributing/writing-for-github-docs/content-model.md` file.
**Note:** This version of the style guide is no longer maintained and will be deprecated. See the [style guide](https://docs.github.com/contributing/style-guide-and-content-model/style-guide) on docs.github.com for the most up-to-date version. Open any pull requests against the `contributing/style-guide-and-content-model/style-guide.md` file.

Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).

Expand Down
Loading

0 comments on commit 3a0dfc6

Please sign in to comment.