m (→Policies and guidelines: fix link markup) |
m (→Release Notes: Would be informative to quantify what "many" means in "many ... applications have migrated". 50%? 5%?) |
||
| (39 intermediate revisions by 4 users not shown) | |||
| Line 6: | Line 6: | ||
Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery. Both the 1.x branch of jQuery that supports Internet Explorer 6 and the 2.x branch of jQuery that only works with modern web browsers will be provided. | Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery. Both the 1.x branch of jQuery that supports Internet Explorer 6 and the 2.x branch of jQuery that only works with modern web browsers will be provided. | ||
== | == Owners == | ||
* Name: [[User:Patches|T.C. Hollingsworth]] | * Name: [[User:Patches|T.C. Hollingsworth]], [[User:Jamielinux|Jamie Nguyen]] | ||
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. --> | <!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. --> | ||
* Email: [mailto:tchollingsworth@gmail.com tchollingsworth@gmail.com] | * Email: [mailto:tchollingsworth@gmail.com tchollingsworth@gmail.com], [mailto:j@jamielinux.com j@jamielinux.com] | ||
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> --> | * Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> --> | ||
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo) | <!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo) | ||
| Line 16: | Line 16: | ||
== Current status == | == Current status == | ||
* Targeted release: [[Releases/ | * Targeted release: [[Releases/23 | Fedora 23 ]] | ||
* Last updated: | * Last updated: 2015-06-23 | ||
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page | <!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page | ||
Bugzilla states meaning as usual: | Bugzilla states meaning as usual: | ||
| Line 26: | Line 26: | ||
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development | CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development | ||
--> | --> | ||
* Tracker bug: | * Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1078903 #1078903] | ||
== Detailed Description == | == Detailed Description == | ||
Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery. | Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery. | ||
The following packages | The following packages are available in Fedora 21 and later and EPEL 6 and later: | ||
* '''js-jquery''' - The latest version of the jQuery 2.x branch, suitable for web applications that are only compatible with modern web browsers that fully support modern web standards. | * '''js-jquery''' - The latest version of the jQuery 2.x branch, suitable for web applications that are only compatible with modern web browsers that fully support modern web standards. | ||
* '''js-jquery1''' - The latest version of the jQuery 1.x branch, suitable for web applications that endeavor to be compatible with older web browsers such as Internet Explorer 6. | * '''js-jquery1''' - The latest version of the jQuery 1.x branch, suitable for web applications that endeavor to be compatible with older web browsers such as Internet Explorer 6. | ||
* '''js-jquery-migrate''' - The jQuery migrate plugin, which is a compatibility shim that enables web applications that depend on older versions of jQuery to work with the latest version, so that they can be ported away from old, unsupported jQuery versions that may potentially have security issues. | * '''js-jquery-migrate''' - The jQuery migrate plugin, which is a compatibility shim that enables web applications that depend on older versions of jQuery to work with the latest version, so that they can be ported away from old, unsupported jQuery versions that may potentially have security issues. | ||
Some new packages are already beginning to use the system version of jQuery with little trouble, so for Fedora 23 we're going to open the doors to converting existing packages. We'll send announcements explaining how to unbundle existing packages. We'll also find all the packages we can that are bundling jQuery and inform maintainers about them, via e-mail only at this time. (We'll save the mass bug filing for F24 to allow maintainers to have a go at it voluntarily first. :-) | |||
== Benefit to Fedora == | == Benefit to Fedora == | ||
| Line 40: | Line 42: | ||
== Scope == | == Scope == | ||
=== Migrating Web Applications === | === Migrating Web Applications === | ||
| Line 58: | Line 56: | ||
Certain documentation frameworks, such as python-sphinx, ship copies of jQuery as well. These frameworks will be modified to use a symlink or other means so that they too can use the new systemwide versions. | Certain documentation frameworks, such as python-sphinx, ship copies of jQuery as well. These frameworks will be modified to use a symlink or other means so that they too can use the new systemwide versions. | ||
=== Release Engineering === | === Release Engineering === | ||
| Line 84: | Line 78: | ||
Once it's all done, change it to <code><nowiki>{{status|done|your_FAS_username}}</nowiki></code> and give yourself a pat on the back! You'll also be awarded a shiny [https://badges.fedoraproject.org/badge/web-warrior Web Warrior badge] for your effort. | Once it's all done, change it to <code><nowiki>{{status|done|your_FAS_username}}</nowiki></code> and give yourself a pat on the back! You'll also be awarded a shiny [https://badges.fedoraproject.org/badge/web-warrior Web Warrior badge] for your effort. | ||
=== Web Application packages that need to be migrated === | === Web Application packages that need to be migrated === | ||
Coming Early July! | |||
=== Documentation frameworks that need attention === | === Documentation frameworks that need attention === | ||
Coming Early July! | |||
== Contingency Plan == | == Contingency Plan == | ||
| Line 141: | Line 100: | ||
jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript. | jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript. | ||
Traditionally, a copy of jQuery has been included with every web application that requires it. Starting with Fedora 21, many of those applications have migrated to a shared system copy of jQuery. | Traditionally, a copy of jQuery has been included with every web application that requires it. Starting with Fedora 21, many <sup>[what fraction?]</sup> of those applications have migrated to a shared system copy of jQuery. | ||
If you're developing an application that uses jQuery on Fedora and don't want to download your own copy or rely on a third-party CDN, you can now install one of our jquery packages and use it instead. You can find the 1.x branch of jQuery that supports Internet Explorer 6 in the js-jquery1 package, and the 2.x branch of jQuery that only works with modern web browsers in the js-jquery package. For more information on using these packages in your applications, see [https://fedoraproject.org/wiki/Web_Assets]. | If you're developing an application that uses jQuery on Fedora and don't want to download your own copy or rely on a third-party CDN, you can now install one of our jquery packages and use it instead. You can find the 1.x branch of jQuery that supports Internet Explorer 6 in the js-jquery1 package, and the 2.x branch of jQuery that only works with modern web browsers in the js-jquery package. For more information on using these packages in your applications, see [https://fedoraproject.org/wiki/Web_Assets]. | ||
[[Category: | [[Category:ChangePageIncomplete]] | ||
<!-- When your change proposal page is completed and ready for review and announcement --> | <!-- When your change proposal page is completed and ready for review and announcement --> | ||
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | <!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | ||
Latest revision as of 14:19, 11 August 2015
jQuery
Summary
jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript.
Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery. Both the 1.x branch of jQuery that supports Internet Explorer 6 and the 2.x branch of jQuery that only works with modern web browsers will be provided.
Owners
- Name: T.C. Hollingsworth, Jamie Nguyen
- Email: tchollingsworth@gmail.com, j@jamielinux.com
- Release notes owner:
Current status
Detailed Description
Traditionally, a copy of jQuery has been included with every web application that requires it. This change will migrate many of those applications to a shared system copy of jQuery.
The following packages are available in Fedora 21 and later and EPEL 6 and later:
- js-jquery - The latest version of the jQuery 2.x branch, suitable for web applications that are only compatible with modern web browsers that fully support modern web standards.
- js-jquery1 - The latest version of the jQuery 1.x branch, suitable for web applications that endeavor to be compatible with older web browsers such as Internet Explorer 6.
- js-jquery-migrate - The jQuery migrate plugin, which is a compatibility shim that enables web applications that depend on older versions of jQuery to work with the latest version, so that they can be ported away from old, unsupported jQuery versions that may potentially have security issues.
Some new packages are already beginning to use the system version of jQuery with little trouble, so for Fedora 23 we're going to open the doors to converting existing packages. We'll send announcements explaining how to unbundle existing packages. We'll also find all the packages we can that are bundling jQuery and inform maintainers about them, via e-mail only at this time. (We'll save the mass bug filing for F24 to allow maintainers to have a go at it voluntarily first. :-)
Benefit to Fedora
Fedora's "first" foundation will finally be extended to a core library of the web. Numerous potential security vulnerabilities, including known cross-site scripting attacks, will be prevented by requiring all web applications to use upstream-maintained versions of jQuery.
Scope
Migrating Web Applications
Web applications that depend on modern versions of jQuery will simply be ported to use the systemwide version instead,
Web applications that use older versions of jQuery (> 1.6.4 but <1.9) will be ported to use jquery-migrate and the systemwide version of jQuery. Packagers will be encouraged to work with upstream to migrate to the latest version of jQuery without jquery-migrate, since using this plugin re-enables misfeatures rightly removed from jQuery core that are XSS holes waiting to happen.
Maintainers of web applications that use extremely old versions of jQuery (< 1.6.4) will be strongly encouraged to work with upstream to migrate to the latest versions of jQuery and update their packages. However, current Fedora policy regarding bundled libraries permits these packages to be grandfathered in, so I am unable to force any action here.
Preliminary repoqueries have been performed to identify potentially affected packages, see the dependencies section for more details.
Migrating documentation frameworks
Certain documentation frameworks, such as python-sphinx, ship copies of jQuery as well. These frameworks will be modified to use a symlink or other means so that they too can use the new systemwide versions.
Release Engineering
No special attention required.
Upgrade/compatibility impact
Modifications to packages in accordance with this Change should be performed such that they are transparent to consumers of these packages.
How To Test
Try a converted web application and make sure it still works. :-)
User Experience
End users should notice no difference. System administrators may be pleased to see that they no longer have dozens of copies of the same file on their systems.
Dependencies
This section will be used to track affected packages and individuals working on them.
If you'd like to take on a task, let us know you're working on it by adding {{status|inprogress|your_FAS_username}} to the status column. If you've got something done, but either need a patch reviewed by the maintainer or a review request for a new package to completed, add {{status|needreview|your_FAS_username}} and link to the relevant bug.
Once it's all done, change it to {{status|done|your_FAS_username}} and give yourself a pat on the back! You'll also be awarded a shiny Web Warrior badge for your effort.
Web Application packages that need to be migrated
Coming Early July!
Documentation frameworks that need attention
Coming Early July!
Contingency Plan
None needed. Packages that aren't converted will continue to just bundle jQuery as they always have.
- Blocks release? No
Documentation
Release Notes
jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript.
Traditionally, a copy of jQuery has been included with every web application that requires it. Starting with Fedora 21, many [what fraction?] of those applications have migrated to a shared system copy of jQuery.
If you're developing an application that uses jQuery on Fedora and don't want to download your own copy or rely on a third-party CDN, you can now install one of our jquery packages and use it instead. You can find the 1.x branch of jQuery that supports Internet Explorer 6 in the js-jquery1 package, and the 2.x branch of jQuery that only works with modern web browsers in the js-jquery package. For more information on using these packages in your applications, see [1].