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

repo sync #25077

Merged
merged 3 commits into from
Apr 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,213 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng
```
- [ ] Create a placeholder release notes file called `data/release-notes/<PRODUCT>/<RELEASE NUMBER>/PLACEHOLDER.yml`. For example `data/release-notes/enterprise-server/3-1/PLACEHOLDER.yml`. Add the following placeholder content to the file:

```
date: '2021-05-04'
**Note:** All of the content in this file will be updated when the release notes are created in the megabranch including the filename `PLACEHOLDER.yml`. You can update the date or leave it as-is and wait to update it when the release notes are finalized.

<details><summary>Click to view placeholder...</summary>

```yaml
date: '2099-12-31'
release_candidate: true
deprecated: false
intro: PLACEHOLDER
intro: |
{% note %}

**Note:** If {% data variables.location.product_location %} is running a release candidate build, you can’t upgrade with a hotpatch. We recommend that you only run release candidates in a test environment.

{% endnote %}

For upgrade instructions, see "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
sections:
bugs:
- PLACEHOLDER
known_issues:
- PLACEHOLDER
```
# Remove section heading if the section contains no notes.

**Note:** All of the content in this file will be updated when the release notes are created in the megabranch including the filename `PLACEHOLDER.yml`. You can update the date or leave it as-is and wait to update it when the release notes are finalized.
features:
# Remove a sub-section heading if the heading contains no notes. If sections
# that regularly recur are missing, add placeholders to this template.

- heading: Instance administration
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Instance services
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Identity and access management
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Authentication
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Migrations
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Policies
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Audit logs
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Connect
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Advanced Security
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Dependabot
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Code security
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Actions
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Packages
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Pages
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Community experience
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Organizations
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Repositories
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Issues
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Projects
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Discussions
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Commits
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Pull requests
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Releases
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Gist
notes:
# LINK TO RELEASES ISSUE
- |
...

- heading: Markdown
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Accessibility
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: GitHub Mobile
notes:
# LINK TO RELEASE ISSUE
- |
...

- heading: Integrations and extensions
notes:
# LINK TO RELEASE ISSUE
- |
...

changes:
# LINK TO RELEASE ISSUE
- |
...

known_issues:
# INCLUDE NOTES FOR RELEASE FROM "GHES Release Note Tracking" PROJECT'S "Known Issues" TAB
- |
...

deprecations:
# LINK TO RELEASE ISSUE
- |
...
```
</details>
- [ ] If this is a release candidate release, add a Release Candidate banner:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
{% data reusables.repositories.sidebar-settings %}
{% data reusables.pages.sidebar-pages %}
4. Under "Custom domain", type your custom domain, then click **Save**. If you are publishing your site from a branch, this will create a commit that adds a `CNAME` file to the root of your source branch. If you are publishing your site with a custom {% data variables.product.prodname_actions %} workflow , no `CNAME` file is created. For more information about your publishing source, see "[AUTOTITLE](/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)."
5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. {% data reusables.pages.contact-dns-provider %}
5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. You can also create `AAAA` records for IPv6 support. If you're implementing IPv6 support, we highly recommend using an `A` record in addition to your `AAAA` record, due to slow adoption of IPv6 globally. {% data reusables.pages.contact-dns-provider %}
- To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
- To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
```shell
Expand All @@ -100,22 +100,24 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
{% data reusables.command_line.open_the_multi_os_terminal %}
6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above.
- For `A` records.
- For `A` records:
```shell
$ dig EXAMPLE.COM +noall +answer -t A
> EXAMPLE.COM 3600 IN A 185.199.108.153
> EXAMPLE.COM 3600 IN A 185.199.109.153
> EXAMPLE.COM 3600 IN A 185.199.110.153
> EXAMPLE.COM 3600 IN A 185.199.111.153
```
- For `AAAA` records.
- For `AAAA` records:
```shell
$ dig EXAMPLE.COM +noall +answer -t AAAA
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153
```

Remember to also check your `A` record.
{% data reusables.pages.build-locally-download-cname %}
{% data reusables.pages.enforce-https-custom-domain %}

Expand Down
16 changes: 16 additions & 0 deletions contributing/content-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,22 @@ Use the [procedural content template](https://github.com/github/docs/blob/main/c
- [Inviting people to manage your enterprise account](https://docs.github.com/en/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)
- [Setting up continuous integration using workflow templates](https://docs.github.com/en/actions/guides/setting-up-continuous-integration-using-workflow-templates)

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

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.

#### Types of releases

GitHub Docs provides release notes for feature releases of GHES and GHAE, and for patch releases of GHES. For more information about releases of each product, see "About upgrades to new releases" in the [GHES](https://docs.github.com/enterprise-server/admin/overview/about-upgrades-to-new-releases) or [GHAE](https://docs.github.com/github-ae@latest/admin/overview/about-upgrades-to-new-releases) documentation.

#### Guidance and example release notes

You can find guidance for the format, style, and tone of release notes, as well as examples of each type of note, in the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#release-notes).

### Troubleshooting

Troubleshooting content includes built-in errors we expect users to encounter, common problems reported to support, and situations people might encounter while completing tasks. Use troubleshooting sections in guides or procedural articles to keep solutions close to procedures. Work with support and product managers to surface common errors and include them in the documentation.
Expand Down
Loading