Skip to content

Commit 2eebf24

Browse files
All: clarify version support; upgrade guide content; new download button
Ref jquery/jquery-wp-content#462 Ref gh-245 Fixes gh-243 Closes gh-246 Co-authored-by: Andre Angelantoni <[email protected]>
1 parent 10c3611 commit 2eebf24

File tree

4 files changed

+77
-27
lines changed

4 files changed

+77
-27
lines changed

pages/download.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ Browse the jQuery CDN at **[releases.jquery.com](https://releases.jquery.com)**
2626

2727
### Upgrade
2828

29-
For help when upgrading jQuery, read the [upgrade guide](/upgrade-guide/).
30-
We also recommend using the [jQuery Migrate plugin](https://github.com/jquery/jquery-migrate)
29+
For help when upgrading jQuery, read the [upgrade guides](/upgrade-guide/).
30+
We also recommend using the [jQuery Migrate plugin](https://github.com/jquery/jquery-migrate).
3131

3232
### jQuery Migrate Plugin
3333

3434
The [jQuery Migrate plugin](https://github.com/jquery/jquery-migrate/#readme) simplifies upgrading from older versions of jQuery. The plugin restores deprecated features and behaviors so that older code will still run properly on newer versions of jQuery.
3535

36-
When upgrading from a pre-1.9 jQuery version to jQuery 1.9 or upto jQuery 3.0, first use jQuery Migrate 1.x:
36+
When upgrading from a pre-1.9 jQuery version to jQuery 1.9 or up to jQuery 3.0, first use jQuery Migrate 1.x:
3737

3838
* <a href="https://code.jquery.com/jquery-migrate-1.4.1.min.js">Download jQuery Migrate 1.4.1</a> (compressed production version)
3939
* <a href="https://code.jquery.com/jquery-migrate-1.4.1.js">Download the uncompressed, development jQuery Migrate 1.4.1</a>
@@ -43,11 +43,12 @@ When migrating from jQuery 3.x to a later jQuery 3.x version, use jQuery Migrate
4343
* <a href="https://code.jquery.com/jquery-migrate-3.5.0.min.js">Download jQuery Migrate 3.5.0</a> (compressed production version)
4444
* <a href="https://code.jquery.com/jquery-migrate-3.5.0.js">Download the uncompressed, development jQuery Migrate 3.5.0</a>
4545

46-
Use the _compressed production_ version to simply restore compatibility issues without changing any application code.
46+
Use the _compressed production_ version to restore compatibility issues without changing any application code.
4747

4848
Use the _uncompressed development_ version to additionally diagnose and help migrate compatibility issues, through helpful warnings on the console that identify how to transition your application code.
4949

5050
## Downloading jQuery using npm or Yarn
51+
5152
jQuery is published on [npm](https://www.npmjs.com/) under the [jquery package](https://www.npmjs.com/package/jquery). You can install the latest version of jQuery with the npm CLI:
5253
```
5354
npm install jquery

pages/index.html

+16-13
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,26 @@
22
"title": "jQuery",
33
"pageTemplate": "page-fullwidth.php",
44
"customFields": [
5-
{ "key": "hide_title", "value": 1 }
5+
{ "key": "hide_title", "value": 1 }
66
]
77
}</script>
88

99
<div id="banner-secondary" class="row">
10-
<div class="downloads-box four columns push-eight">
11-
<div class="download-main">
12-
<a href="/download/" class="button large">
13-
<span class="download"></span>
14-
Download jQuery
15-
<span>v3.7.1</span>
16-
<span class="support-notice">The 1.x and 2.x branches no longer receive patches.</span>
17-
</a>
18-
<div class="download-options">
19-
<a href="https://github.com/jquery/jquery">View Source on GitHub →</a>
20-
<a href="https://learn.jquery.com/about-jquery/how-jquery-works/">How jQuery Works →</a>
21-
</div>
10+
<div class="download four columns push-eight">
11+
<a href="/download/" class="button large">
12+
<span class="download-button-content">
13+
<span class="download-icon"></span>
14+
<span class="download-message">
15+
<span>Download jQuery</span>
16+
<span class="download-version">v3.7.1</span>
17+
</span>
18+
</span>
19+
</a>
20+
<div class="download-options">
21+
<div class="support-notice">Only the latest version of jQuery is supported.</div>
22+
<a href="/support">Discover Support Options</a>
23+
<a href="https://github.com/jquery/jquery">View Source on GitHub →</a>
24+
<a href="https://learn.jquery.com/about-jquery/how-jquery-works/">How jQuery Works →</a>
2225
</div>
2326
</div>
2427
<div class="features-box row eight columns pull-four">

pages/support.md

+26-7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@
44
}
55
</script>
66

7+
## Supported versions
8+
9+
We support only the latest version of jQuery. The 1.x and 2.x branches are no longer supported.
10+
11+
jQuery 3.x is the current version branch of jQuery.
12+
13+
jQuery 4.0 is in beta. Once jQuery 4.0 is released, we will provide security patches and bug fixes on the 3.x branch for a limited time.
14+
15+
### Unsupported versions
16+
17+
When using a version earlier than the latest version, there are a few options:
18+
19+
* [Upgrade](/download#upgrade) to the latest version of jQuery. The best solution is to upgrade as it will include all features, bug fixes, security patches, and improvements. The [jQuery Migrate Plugin](https://github.com/jquery/jquery-migrate) and [upgrade guides](/upgrade-guide) are available to assist with upgrading.
20+
* Continue using an older version of jQuery, but include all security patches through [commercial security support](#commercial-support).
21+
* Continue using an older version of jQuery without security patches. **However, this can come with multiple risks.**
22+
723
## Community support
824

925
The following learning resources are available online and free of charge:
@@ -27,17 +43,11 @@ We are on [Libera Chat IRC](https://libera.chat/) in the `#jquery` channel where
2743

2844
StackOverflow is a great place to ask questions and find support for all jQuery projects. Search or create [questions tagged with "jquery"](https://stackoverflow.com/questions/tagged/jquery), or refer to the ["jquery" tag introduction](https://stackoverflow.com/tags/jquery/info).
2945

30-
### Archives
31-
32-
* [Freenode IRC chat channels](https://irc.jquery.org/) (2011-2021)
33-
* [jQuery Forum](https://forum.jquery.com/) (2010-2021): For questions and advice regarding jQuery Core, jQuery UI, Themeroller, QUnit, development of jQuery Plugins, and more.
34-
* [jQuery Accessibility mailing list](https://groups.google.com/group/jquery-a11y) (2008-2016).
35-
3646
## Commercial support
3747

3848
The following companies offer commercial support services for jQuery.
3949

40-
* **[Bocoup](https://bocoup.com/)** builds complex cross device and cross platform JavaScript software for startups, the Fortune 500, and federally funded education projects. Bocoup offers in-depth JavaScript training on a number of subjects including jQuery. Learn more at <https://bocoup.com/services/training> or contact at <https://bocoup.com/contact>.
50+
[HeroDevs](https://www.herodevs.com/support/jquery-nes?utm_source=jQuery&utm_medium=link&utm_campaign=eol_support_jQuery) offers security and compatibility support for EOL versions of jQuery through the [OpenJS Ecosystem Sustainability Program](https://openjsf.org/ecosystem-sustainability-program) and is an approved commercial support vendor. Find out more about their [Never Ending Support options](https://www.herodevs.com/support/jquery-nes?utm_source=jQuery&utm_medium=link&utm_campaign=eol_support_jQuery).
4151

4252
-------
4353

@@ -72,3 +82,12 @@ For guidance on branding and trademark usage, visit <https://brand.jquery.org/>.
7282
For reporting bugs in libraries, documentation, or content, the project's GitHub issue tracker should be used. All jQuery projects can be found at https://github.com/jquery
7383

7484
Still haven't found what you're looking for? Please feel free to contact: [[email protected]](mailto:[email protected])
85+
86+
-------
87+
88+
## Archives
89+
90+
* [Freenode IRC chat channels](https://irc.jquery.org/) (2011-2021)
91+
* [jQuery Forum](https://forum.jquery.com/) (2010-2021): For questions and advice regarding jQuery Core, jQuery UI, Themeroller, QUnit, development of jQuery Plugins, and more.
92+
* [jQuery Accessibility mailing list](https://groups.google.com/group/jquery-a11y) (2008-2016).
93+

pages/upgrade-guide.md

+30-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,35 @@
33
"noHeadingLinks": true
44
}</script>
55

6-
## [3.5 Upgrade Guide](/upgrade-guide/3.5/)
6+
## jQuery Upgrade Guides
77

8-
## [3.0 Upgrade Guide](/upgrade-guide/3.0/)
8+
The jQuery upgrade guides provide information on all breaking changes and some notable changes in pinnacle versions of jQuery. Overall, jQuery has had very strong backwards compatibility throughout its history. However, these breaking changes were deemed necessary to address security concerns, fix bugs that could not be fixed without behavior changes, or to adapt to the introduction of modern APIs on the web. Most of the breaking changes listed should not apply to the majority of users, but these guides add some context and explanation for each change.
99

10-
## [1.9 Upgrade Guide](/upgrade-guide/1.9/)
10+
### [3.5 Upgrade Guide](/upgrade-guide/3.5/)
11+
12+
### [3.0 Upgrade Guide](/upgrade-guide/3.0/)
13+
14+
### [1.9 Upgrade Guide](/upgrade-guide/1.9/)
15+
16+
### Upgrading jQuery
17+
18+
The jQuery Team provides the [jQuery Migrate plugin](https://github.com/jquery/jquery-migrate) to make upgrading jQuery as easy as possible. It is mainly meant as a development tool that generates warning messages in the browser console that can be used to identify and fix compatibility issues. It temporarily restores deprecated features and behaviors so that older code will still run on newer versions of jQuery while the compatibility issues are addressed.
19+
20+
There are two versions of jQuery Migrate: [1.x](https://github.com/jquery/jquery-migrate/tree/1.x-stable) and [3.x](https://github.com/jquery/jquery-migrate) (there is no Migrate 2.x). Only one version should be used at a time, but you may need to use both in succession if upgrading from a jQuery version that predates jQuery 1.9.
21+
22+
For example, if your current jQuery version is 1.4.4, first upgrade to jQuery 1.12.4 with jQuery Migrate 1.x and then upgrade to the latest jQuery with jQuery Migrate 3.x. If your current version is 1.9 or later, you can update straight to the latest jQuery with jQuery Migrate 3.x.
23+
24+
#### Using jQuery Migrate
25+
26+
First, add jQuery Migrate to your page *after* loading jQuery.
27+
28+
```html
29+
<script src="https://code.jquery.com/jquery-3.7.1.js"></script>
30+
<script src="https://code.jquery.com/jquery-migrate-3.4.1.js"></script>
31+
```
32+
33+
Then, test your website or application. As different jQuery APIs are used, jQuery Migrate will log messages to the console warning about any deprecations or breaking changes. Address each warning one at a time.
34+
35+
Finally, when no more warnings are logged to the console and all breaking changes have been addressed, the jQuery Migrate can be removed and migration is complete!
36+
37+
See the [jQuery Migrate README](https://github.com/jquery/jquery-migrate) for more details.

0 commit comments

Comments
 (0)