Skip to content

Commit 6069277

Browse files
OctomergerOctomerger
authored
Merge pull request #25077 from github/repo-sync
repo sync
2 parents 9fe2f0b + 402f296 commit 6069277

File tree

4 files changed

+401
-12
lines changed

4 files changed

+401
-12
lines changed

‎.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

Lines changed: 202 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,213 @@ If you aren't comfortable going through the steps alone, sync up with a docs eng
3232
```
3333
- [ ] 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:
3434
35-
```
36-
date: '2021-05-04'
35+
**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.
36+
37+
<details><summary>Click to view placeholder...</summary>
38+
39+
```yaml
40+
date: '2099-12-31'
3741
release_candidate: true
3842
deprecated: false
39-
intro: PLACEHOLDER
43+
intro: |
44+
{% note %}
45+
46+
**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.
47+
48+
{% endnote %}
49+
50+
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)."
4051
sections:
41-
bugs:
42-
- PLACEHOLDER
43-
known_issues:
44-
- PLACEHOLDER
45-
```
52+
# Remove section heading if the section contains no notes.
4653
47-
**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.
54+
features:
55+
# Remove a sub-section heading if the heading contains no notes. If sections
56+
# that regularly recur are missing, add placeholders to this template.
57+
58+
- heading: Instance administration
59+
notes:
60+
# LINK TO RELEASE ISSUE
61+
- |
62+
...
63+
64+
- heading: Instance services
65+
notes:
66+
# LINK TO RELEASE ISSUE
67+
- |
68+
...
69+
70+
- heading: Identity and access management
71+
notes:
72+
# LINK TO RELEASE ISSUE
73+
- |
74+
...
75+
76+
- heading: Authentication
77+
notes:
78+
# LINK TO RELEASE ISSUE
79+
- |
80+
...
81+
82+
- heading: Migrations
83+
notes:
84+
# LINK TO RELEASE ISSUE
85+
- |
86+
...
87+
88+
- heading: Policies
89+
notes:
90+
# LINK TO RELEASE ISSUE
91+
- |
92+
...
93+
94+
- heading: Audit logs
95+
notes:
96+
# LINK TO RELEASE ISSUE
97+
- |
98+
...
99+
100+
- heading: GitHub Connect
101+
notes:
102+
# LINK TO RELEASE ISSUE
103+
- |
104+
...
105+
106+
- heading: GitHub Advanced Security
107+
notes:
108+
# LINK TO RELEASE ISSUE
109+
- |
110+
...
111+
112+
- heading: Dependabot
113+
notes:
114+
# LINK TO RELEASE ISSUE
115+
- |
116+
...
117+
118+
- heading: Code security
119+
notes:
120+
# LINK TO RELEASE ISSUE
121+
- |
122+
...
48123
124+
- heading: GitHub Actions
125+
notes:
126+
# LINK TO RELEASE ISSUE
127+
- |
128+
...
129+
130+
- heading: GitHub Packages
131+
notes:
132+
# LINK TO RELEASE ISSUE
133+
- |
134+
...
135+
136+
- heading: GitHub Pages
137+
notes:
138+
# LINK TO RELEASE ISSUE
139+
- |
140+
...
141+
142+
- heading: Community experience
143+
notes:
144+
# LINK TO RELEASE ISSUE
145+
- |
146+
...
147+
148+
- heading: Organizations
149+
notes:
150+
# LINK TO RELEASE ISSUE
151+
- |
152+
...
153+
154+
- heading: Repositories
155+
notes:
156+
# LINK TO RELEASE ISSUE
157+
- |
158+
...
159+
160+
- heading: Issues
161+
notes:
162+
# LINK TO RELEASE ISSUE
163+
- |
164+
...
165+
166+
- heading: Projects
167+
notes:
168+
# LINK TO RELEASE ISSUE
169+
- |
170+
...
171+
172+
- heading: GitHub Discussions
173+
notes:
174+
# LINK TO RELEASE ISSUE
175+
- |
176+
...
177+
178+
- heading: Commits
179+
notes:
180+
# LINK TO RELEASE ISSUE
181+
- |
182+
...
183+
184+
- heading: Pull requests
185+
notes:
186+
# LINK TO RELEASE ISSUE
187+
- |
188+
...
189+
190+
- heading: Releases
191+
notes:
192+
# LINK TO RELEASE ISSUE
193+
- |
194+
...
195+
196+
- heading: Gist
197+
notes:
198+
# LINK TO RELEASES ISSUE
199+
- |
200+
...
201+
202+
- heading: Markdown
203+
notes:
204+
# LINK TO RELEASE ISSUE
205+
- |
206+
...
207+
208+
- heading: Accessibility
209+
notes:
210+
# LINK TO RELEASE ISSUE
211+
- |
212+
...
213+
214+
- heading: GitHub Mobile
215+
notes:
216+
# LINK TO RELEASE ISSUE
217+
- |
218+
...
219+
220+
- heading: Integrations and extensions
221+
notes:
222+
# LINK TO RELEASE ISSUE
223+
- |
224+
...
225+
226+
changes:
227+
# LINK TO RELEASE ISSUE
228+
- |
229+
...
230+
231+
known_issues:
232+
# INCLUDE NOTES FOR RELEASE FROM "GHES Release Note Tracking" PROJECT'S "Known Issues" TAB
233+
- |
234+
...
235+
236+
deprecations:
237+
# LINK TO RELEASE ISSUE
238+
- |
239+
...
240+
```
241+
</details>
49242
- [ ] If this is a release candidate release, add a Release Candidate banner:
50243

51244
```

‎content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
8080
{% data reusables.repositories.sidebar-settings %}
8181
{% data reusables.pages.sidebar-pages %}
8282
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)."
83-
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 %}
83+
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 %}
8484
- To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
8585
- To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
8686
```shell
@@ -100,22 +100,24 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom
100100
{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %}
101101
{% data reusables.command_line.open_the_multi_os_terminal %}
102102
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.
103-
- For `A` records.
103+
- For `A` records:
104104
```shell
105105
$ dig EXAMPLE.COM +noall +answer -t A
106106
> EXAMPLE.COM 3600 IN A 185.199.108.153
107107
> EXAMPLE.COM 3600 IN A 185.199.109.153
108108
> EXAMPLE.COM 3600 IN A 185.199.110.153
109109
> EXAMPLE.COM 3600 IN A 185.199.111.153
110110
```
111-
- For `AAAA` records.
111+
- For `AAAA` records:
112112
```shell
113113
$ dig EXAMPLE.COM +noall +answer -t AAAA
114114
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153
115115
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153
116116
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153
117117
> EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153
118118
```
119+
120+
Remember to also check your `A` record.
119121
{% data reusables.pages.build-locally-download-cname %}
120122
{% data reusables.pages.enforce-https-custom-domain %}
121123

‎contributing/content-model.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,22 @@ Use the [procedural content template](https://github.com/github/docs/blob/main/c
284284
- [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)
285285
- [Setting up continuous integration using workflow templates](https://docs.github.com/en/actions/guides/setting-up-continuous-integration-using-workflow-templates)
286286

287+
### Release notes
288+
289+
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.
290+
291+
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.
292+
293+
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.
294+
295+
#### Types of releases
296+
297+
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.
298+
299+
#### Guidance and example release notes
300+
301+
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).
302+
287303
### Troubleshooting
288304

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

0 commit comments

Comments
 (0)