Skip to content

Commit 6f28681

Browse files
committed
- update formatting for upgrade guide
1 parent 2ad6337 commit 6f28681

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/upgrading.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,11 @@ By gathering feedback in the beta PR, we ensure all discussions and issues are c
148148

149149
## Frequently Asked Questions (FAQ)
150150

151-
### **How do I know if a release contains breaking changes?**
151+
### How do I know if a release contains breaking changes?
152152

153153
Breaking changes will be clearly communicated in the release notes, changelog, and upgrade guide for each version. Each breaking change is categorized by Impact Scope and Effort to Upgrade so you can quickly understand the potential impact on your project.
154154

155-
### **What should I do if I experience issues after upgrading?**
155+
### What should I do if I experience issues after upgrading?
156156

157157
If you encounter issues after upgrading, we recommend:
158158

@@ -164,19 +164,19 @@ If you encounter issues after upgrading, we recommend:
164164
> [!TIP]
165165
> For best results, review the upgrade guide and release notes, and consider reaching out to the community on Discord or GitHub Discussions if issues persist.
166166
167-
### **How can I test new versions before upgrading my production environment?**
167+
### How can I test new versions before upgrading my production environment?
168168

169169
We offer a **beta period** of approximately 30 days for major releases, where you can test the upcoming version on a specific **release branch**. During this period, you can help identify any issues and provide feedback. We recommend setting up a staging environment for testing major upgrades before deploying to production.
170170

171-
### **What are the supported versions of WPGraphQL?**
171+
### What are the supported versions of WPGraphQL?
172172

173173
WPGraphQL supports the latest `minor.patch` of the last 2 major versions. If you're on an older version, we encourage you to upgrade to one of the latest supported versions to ensure continued support, access to new features, and security patches.
174174

175-
### **How are deprecations handled?**
175+
### How are deprecations handled?
176176

177177
Before we remove or change a feature that could break backward compatibility, we may deprecate the functionality first. Deprecations are communicated in release notes, and deprecated features will continue to function for a specified period but will trigger warnings. This gives you time to adjust your code before the feature is fully removed or changed.
178178

179-
### **How do I stay informed about new releases and breaking changes?**
179+
### How do I stay informed about new releases and breaking changes?
180180

181181
You can stay informed by following these communication channels:
182182

@@ -187,14 +187,14 @@ You can stay informed by following these communication channels:
187187

188188
We also publish detailed release notes and upgrade guides with each new version.
189189

190-
### **What should I do if I am using a deprecated feature?**
190+
### What should I do if I am using a deprecated feature?
191191

192192
If you're using a deprecated feature, we recommend reviewing the release notes for the deprecation details. You’ll usually have a specified period during which the deprecated feature will continue to function. Use this time to update your code to the newer methods before the feature is fully removed.
193193

194-
### **Does WPGraphQL provide long-term support (LTS) for specific versions?**
194+
### Does WPGraphQL provide long-term support (LTS) for specific versions?
195195

196196
At this time, WPGraphQL does not offer long-term support for specific versions. We recommend staying up to date with the latest version to ensure compatibility and support.
197197

198-
### **Are security updates backported to older versions?**
198+
### Are security updates backported to older versions?
199199

200200
General and critical security updates are only backported to the latest `minor.patch` of the last 2 major versions when possible in a non-breaking way. If you are using an older version of WPGraphQL, we recommend upgrading to a supported version to ensure your site remains secure.

0 commit comments

Comments
 (0)