Skip to content

Commit

Permalink
Remove references to GHAE from contributing docs (#46616)
Browse files Browse the repository at this point in the history
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
  • Loading branch information
3 people authored Nov 28, 2023
1 parent e71447e commit 3d23f58
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Titles can be challenging. Use these general guidelines to help create clear, he

## Product callout

Use the product callout when a feature is available in specific products only and that availability cannot be conveyed by versioning alone. For example, if a feature is available for GHEC, GHES, and GHAE, you can version content about the feature for GHEC, GHES, and GHAE only. If a feature is available for Pro, Team, GHEC, GHES, and GHAE (but not Free), use a product callout to convey that availability.
Use the product callout when a feature is available in specific products only and that availability cannot be conveyed by versioning alone. For example, if a feature is available for GHEC and GHES, you can version content about the feature for GHEC and GHES only. If a feature is available for Pro, Team, GHEC, and GHES (but not Free), use a product callout to convey that availability.

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,7 @@ Use "development container configuration files" to refer to all of the files in

Use the terms `licenses` and `active committers` when you refer to {% data variables.product.prodname_GH_advanced_security %} billing.

We used to use the term `seats` to describe the number of accounts that can use {% data variables.product.prodname_GH_advanced_security %} in an enterprise. People can be confused by the term `seats`, so we removed this term from GitHub.com in autumn 2022 and versions from GHES/GHAE 3.7 onward do not use it.
We used to use the term `seats` to describe the number of accounts that can use {% data variables.product.prodname_GH_advanced_security %} in an enterprise. People can be confused by the term `seats`, so we removed this term from GitHub.com in autumn 2022 and versions from GHES 3.7 onward do not use it.

### {% data variables.product.pat_generic_caps_plural %}

Expand Down Expand Up @@ -1342,9 +1342,6 @@ If the reader manages an enterprise account, and you're describing the people's
- {% data variables.product.prodname_ghe_server %}
- **Use:** If you need to temporarily take over a user account...
- **Avoid:** If you need to temporarily take over a personal account...
- {% data variables.product.prodname_ghe_managed %}
- **Use:** Authorized users can access your enterprise from any IP address.
- **Avoid:** Authorized personal accounts can access your enterprise from any IP address.
The following documentation should reference "user accounts."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ The order of precedence is specified in [`lib/all-versions.js`](https://github.c
1. {% data variables.product.prodname_free_team %}, {% data variables.product.prodname_pro %}, or {% data variables.product.prodname_team %} (`fpt`)
1. {% data variables.product.prodname_ghe_cloud %} (`ghec`)
1. {% data variables.product.prodname_ghe_server %} (`ghes`)
1. {% data variables.product.prodname_ghe_managed %} (`ghae`)

If a page titled `ARTICLE` is only available in {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}, the link `https://docs.github.com/ARTICLE` will automatically redirect to `https://docs.github.com/enterprise-cloud@latest/ARTICLE` because {% data variables.product.prodname_ghe_cloud %} has precedence over {% data variables.product.prodname_ghe_server %}.<!-- markdownlint-disable-line search-replace -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Titles should be descriptive and follow the guidelines for titles in the content
## Versioning
If a video is only relevant for specific {% data variables.product.prodname_dotcom %} products (Free, Pro and Team; {% data variables.product.prodname_ghe_server %}; {% data variables.product.prodname_ghe_managed %}; and {% data variables.product.prodname_ghe_cloud %}), the video must be versioned for those products. Use Liquid conditional statements to version the videos appropriately. The Liquid conditional versioning may need to be added when the content is initially created, or may need to be added when the content is updated for a feature update or {% data variables.product.prodname_enterprise %} release. For more information about liquid conditional statements and versioning, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation)."
If a video is only relevant for specific {% data variables.product.prodname_dotcom %} products (Free, Pro and Team; {% data variables.product.prodname_ghe_server %}; and {% data variables.product.prodname_ghe_cloud %}), the video must be versioned for those products. Use Liquid conditional statements to version the videos appropriately. The Liquid conditional versioning may need to be added when the content is initially created, or may need to be added when the content is updated for a feature update or {% data variables.product.prodname_enterprise %} release. For more information about liquid conditional statements and versioning, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation)."
## Video hosting
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ redirect_from:

On {% data variables.product.prodname_docs %}, we provide versions of our documentation that reflect the differences in UI and functionality across {% data variables.product.company_short %}'s major product offerings. Contributors can use versioning syntax to scope content to a specific product offering.

Versioning syntax allows the reader to manually choose the version of the documentation that applies to the product they're using. {% data variables.product.prodname_docs %}' URLs can also include versioning information, which allows links from {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_ghe_server %}, and {% data variables.product.prodname_ghe_managed %} to send the reader directly to documentation for the product they're using.
Versioning syntax allows the reader to manually choose the version of the documentation that applies to the product they're using. {% data variables.product.prodname_docs %}' URLs can also include versioning information, which allows links from {% data variables.product.prodname_dotcom_the_website %} and {% data variables.product.prodname_ghe_server %} to send the reader directly to documentation for the product they're using.

## How and where to version

Expand Down Expand Up @@ -51,7 +51,7 @@ There are two types of versioning syntax for {% data variables.product.prodname_

## About the different versions of {% data variables.product.company_short %}

We provide versioned documentation for users of {% data variables.product.prodname_dotcom_the_website %} plans including {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, and {% data variables.product.prodname_ghe_managed %}. If multiple versions of a page exist on the site, readers can choose the version from the version picker at the top of the page.
We provide versioned documentation for users of {% data variables.product.prodname_dotcom_the_website %} plans including {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. If multiple versions of a page exist on the site, readers can choose the version from the version picker at the top of the page.

### {% data variables.product.prodname_dotcom_the_website %}

Expand All @@ -71,10 +71,6 @@ Documentation for {% data variables.product.prodname_ghe_server %} has multiple

The versions are named `enterprise-server@<release>`. The short name is `ghes`. In Liquid conditionals, we can specify ranges, like `ghes > 3.0`. For more information, see "[Versioning with Liquid conditional operators](#versioning-with-liquid-conditional-operators)."

### {% data variables.product.prodname_ghe_managed %}

Versioning for {% data variables.product.prodname_ghe_managed %} uses the `github-ae@latest` version. The short name is `ghae`.

## Versioning in the YAML frontmatter

You can use the `versions` property within a file's frontmatter to define which products an article will appear for. Index files require a `versions` property, but they will be automatically versioned based on the versions of their children.
Expand Down Expand Up @@ -123,10 +119,10 @@ If you define multiple products in the `versions` key within a page's YAML front

### Comparison operators

For versions that don't have numbered releases (like `fpt` and `ghae`), you have two options:
For versions that don't have numbered releases (like `fpt` and `ghec`), you have two options:

- `{% raw %}{% ifversion ghae %}{% endraw %}`
- `{% raw %}{% ifversion not ghae %}{% endraw %}`
- `{% raw %}{% ifversion ghec %}{% endraw %}`
- `{% raw %}{% ifversion not ghec %}{% endraw %}`

For versions that have numbered releases (currently only `ghes`), you can do the same for content that is either available in all of the releases or not available in any of the releases:

Expand Down Expand Up @@ -219,7 +215,6 @@ versions:
fpt: '*'
ghec: '*'
ghes: '>3.1'
ghae: '*'
```

The format and allowed values are the same as the frontmatter versions property. For more information, see "[Versions](https://github.com/github/docs/tree/main/content#versions)" in the `github/docs` repository README.
Expand Down Expand Up @@ -251,29 +246,6 @@ versions:

The schema for validating the feature versioning lives in [`src/content-linter/lib/feature-versions-schema.js`](https://github.com/github/docs/blob/main/src/content-linter/lib/feature-versions-schema.js) and is exercised by [`tests/linting/lint-versioning.js`](https://github.com/github/docs/blob/main/src/content-linter/tests/lint-versioning.js).

## Versioning for {% data variables.product.prodname_ghe_managed %}

{% data variables.product.prodname_docs %} shows only the documentation for the latest version of {% data variables.product.prodname_ghe_managed %}. For more information, see "[About the displayed version of {% data variables.product.prodname_ghe_managed %} documentation](#about-the-displayed-version-of-github-ae-documentation)."

You can version documentation to appear in the current {% data variables.product.prodname_ghe_managed %} documentation set in two ways:

- In Liquid syntax, use `ghae` or <code>ghae > VERSION</code>.

- For example, if you want documentation to be visible for {% data variables.product.prodname_ghe_managed %} 3.6 and later, use `ghae > 3.5`.
- If you're confident that the change is available in the latest public release of {% data variables.product.prodname_ghe_managed %} and you want documentation to appear immediately on {% data variables.product.prodname_docs %}, you can always just use `ghae`.
- In YAML front matter or [feature-based versioning files](#feature-based-versioning), use <code>ghae: '> VERSION'</code>.

- For example, if you want documentation to be visible for {% data variables.product.prodname_ghe_managed %} 3.6 and later, use `ghae: '> 3.5'`.
- If you're confident that the change is available in the latest public release of {% data variables.product.prodname_ghe_managed %} and you want documentation to appear immediately on {% data variables.product.prodname_docs %}, you can always use `ghae: '*'`.

### About the displayed version of {% data variables.product.prodname_ghe_managed %} documentation

We display one version of {% data variables.product.prodname_ghe_managed %} documentation on {% data variables.product.prodname_docs %}: the latest. We define "latest" in the site's source, within [`all-versions.js`](https://github.com/github/docs/blob/main/src/versions/lib/all-versions.js#L58). In almost all cases, this value is a safe place to determine the latest public release of {% data variables.product.prodname_ghe_managed %}.

"Latest" corresponds with the latest version of {% data variables.product.prodname_ghe_managed %} that we've deployed to the first customer using the product in production. Generally, {% data variables.product.company_short %} upgrades all production customers on {% data variables.product.prodname_ghe_managed %} to the latest version around the same time, so Product considers only showing the latest documentation an acceptable compromise.

Product notifies Docs Content of new releases via release issues in `github/releases`.

## Best practices

Versioned content impacts the reader, but also impacts anyone who contributes to or reviews the content. Here are a few tips to improve the writing, reading, and reviewing experience for versioning syntax. None of these practices are mandatory and you will find edge and corner cases, but they're intended as useful heuristics to help you think through versioning.
Expand Down

0 comments on commit 3d23f58

Please sign in to comment.