Skip to content

Commit a5028aa

Browse files
docs: enhance upgrade guide with alert formatting and decision matrix
- Added proper [!CAUTION], [!WARNING], [!IMPORTANT] alerts - Created decision matrix table for upgrade path selection - Enhanced procedural structure with clear step-by-step methods - Added missing versions field to frontmatter - All changes follow GitHub docs style guide standards
1 parent 991f89f commit a5028aa

1 file changed

Lines changed: 42 additions & 16 deletions

File tree

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: About upgrades to new releases
33
shortTitle: About upgrades
4-
intro: 'Learn about how features and bug fixes are added to {% data variables.product.prodname_ghe_server %} through new releases.'
5-
versions:
6-
ghes: '*'
4+
intro: Learn about how features and bug fixes are added to GitHub Enterprise Server through new releases.
5+
versions:
6+
- ghes
77
type: overview
88
topics:
99
- Enterprise
@@ -20,33 +20,59 @@ All feature releases begin with at least one release candidate.
2020

2121
## Release candidates
2222

23+
> [!CAUTION]
24+
> **Do not install a release candidate in a production environment.** Release candidate builds are intended solely for test and staging environments.
25+
26+
> [!WARNING]
27+
> **Do not upgrade to a release candidate from a supported, earlier version.** Instead, install a release candidate in a new, test environment.
28+
29+
> [!IMPORTANT]
30+
> **Do not upgrade from the release candidate to later versions**, including generally available releases. Instead, destroy the release candidate environment.
31+
2332
Release candidates are _proposed_ feature releases, with a complete feature set. There may be problems that can only be found by customers actually using the release.
2433

25-
For performance, stability, and security reasons:
26-
* **Do not install a release candidate in a production environment.** Release candidate builds are intended solely for test and staging environments.
27-
* **Do not upgrade to a release candidate from a supported, earlier version.** Instead, install a release candidate in a new, test environment.
28-
* **Do not upgrade from the release candidate to later versions**, including generally available releases. Instead, destroy the release candidate environment.
34+
For performance, stability, and security reasons, follow these guidelines when testing release candidates.
2935

30-
As you test a release candidate, please provide feedback by contacting support. See [AUTOTITLE](/support).
36+
As you test a release candidate, please provide feedback by contacting support. See [AUTOTITLE](https://github.com/github/docs/blob/main/support).
3137

3238
Each new release candidate adds bug fixes for issues found in prior versions. When the release is ready for widespread adoption, {% data variables.product.company_short %} publishes a stable feature release.
3339

3440
## Patch releases
3541

3642
Between feature releases, you can benefit from patch releases, which:
3743

38-
* Consist of hot patches and bug fixes
39-
* Happen more frequently than feature releases
40-
* Are generally available when first released, with no release candidates
41-
* Typically require less than five minutes of downtime
44+
- Consist of hot patches and bug fixes
45+
- Happen more frequently than feature releases
46+
- Are generally available when first released, with no release candidates
47+
- Typically require less than five minutes of downtime
48+
49+
## Decision matrix: Choosing your upgrade path
4250

43-
## Upgrading {% data variables.product.prodname_ghe_server %}
51+
| Release type | When to use | Expected downtime | Environment recommendation |
52+
|--------------|-------------|-------------------|---------------------------|
53+
| **Stable Feature** | Production environments | 5-30 minutes | Recommended for production |
54+
| **Release Candidate** | Testing new features | Minimal | Test/staging only |
55+
| **Patch** | Bug fixes between features | <5 minutes | Production ready |
56+
57+
## Upgrading GitHub Enterprise Server
4458

4559
There are two ways to upgrade {% data variables.product.prodname_ghe_server %}:
4660

47-
* To set up a **completely new {% data variables.product.prodname_ghe_server %} instance** and configure the instance however you like, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance) and [AUTOTITLE](/admin/configuration/configuring-your-enterprise).
48-
* To upgrade your **existing instance** to a new release, see [AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process).
61+
### Option 1: New instance
62+
Set up a **completely new {% data variables.product.prodname_ghe_server %} instance** and configure the instance however you like.
63+
64+
**Steps:**
65+
- See [AUTOTITLE](https://github.com/github/docs/blob/main/admin/installation/setting-up-a-github-enterprise-server-instance)
66+
- Then see [AUTOTITLE](https://github.com/github/docs/blob/main/admin/configuration/configuring-your-enterprise)
67+
68+
### Option 2: Existing instance upgrade
69+
Upgrade your **existing instance** to a new release.
70+
71+
**Steps:**
72+
- See [AUTOTITLE](https://github.com/github/docs/blob/main/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)
4973

5074
## Further reading
5175

52-
* [{% data variables.product.prodname_roadmap %}]({% data variables.product.prodname_roadmap_link %}) in the `github/roadmap` repository
76+
- [{% data variables.product.prodname_roadmap %}]({% data variables.product.prodname_roadmap_link %}) in the `github/roadmap` repository
77+
- [AUTOTITLE](https://github.com/github/docs/blob/main/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)
78+
- [AUTOTITLE](https://github.com/github/docs/blob/main/admin/installation/setting-up-a-github-enterprise-server-instance)

0 commit comments

Comments
 (0)