Skip to content

Commit

Permalink
MAGEDOC-3691: Release page update (#4246)
Browse files Browse the repository at this point in the history
* MAGEDOC-3691: Created new page for policy and changed references to release candidate and stable

* MAGEDOC-3691: Updated release policy per PdM feedback

* MAGEDOC-3691: Updated links

* MAGEDOC-3691: Replaced plain text product name with var

* MAGEDOC-3691: More revisions per PdM feedback

* MAGEDOC-3691: More revisions per PdM feedback
  • Loading branch information
jeff-matthews committed Apr 16, 2019
1 parent 218902f commit 4fbdfa9
Show file tree
Hide file tree
Showing 10 changed files with 79 additions and 53 deletions.
1 change: 1 addition & 0 deletions _config.yml
Expand Up @@ -143,6 +143,7 @@ relative_links:
- extensions
- guides
- redoc
- release
- tmp
- 404.md
- availability.md
Expand Down
20 changes: 10 additions & 10 deletions _data/compatibility.yml
Expand Up @@ -8,31 +8,31 @@ extension:
-
name: 1.4.6
support:
2.3.0: stable
2.3.1: stable
2.3.0: general availability
2.3.1: general availability
-
name: 1.5.1
support:
2.3.0: stable
2.3.1: stable
2.3.0: general availability
2.3.1: general availability
-
name: Multi Source Inventory
versions:
-
name: 1.1.0
support:
2.3.0: stable
2.3.1: stable
2.3.0: general availability
2.3.1: general availability
-
name: 1.0.3
support:
2.3.0: stable
2.3.1: stable
2.3.0: general availability
2.3.1: general availability
-
name: Page Builder
versions:
-
name: 1.0.0
support:
2.3.0: release candidate
2.3.1: stable
2.3.0: open beta
2.3.1: general availability
10 changes: 10 additions & 0 deletions _data/toc/release.yml
@@ -0,0 +1,10 @@
label: Release Information
pages:

- label: Upcoming releases
url: /release/
versionless: true

- label: Release policy
url: /release/policy
versionless: true
2 changes: 1 addition & 1 deletion _data/whats-new.yml
Expand Up @@ -923,7 +923,7 @@ entries:
versions: 2.3.x
type: Technical changes
date: October 5 2018
- description: Added a 2.3 [product availability](https://devdocs.magento.com/release/#product-availability)
- description: Added a 2.3 [product availability](https://devdocs.magento.com/release/#availability)
topic.
versions: 2.3.x
type: New topic
Expand Down
16 changes: 8 additions & 8 deletions _includes/compatibility.html
Expand Up @@ -4,6 +4,12 @@
{% assign extensions = include.data.extension | where: "name", include.extension %}
{% endif %}

**General availability**{: .status-light.general-availability } – version that has been thoroughly tested by Magento and is fully supported.

**Open beta**{: .status-light.open-beta } – pre-release version that has been thoroughly tested by Magento, but is not yet included under Magento Support.

**Not supported**{: .status-light.not-supported } - version that is not compatible with a Commerce release.

<table class="compatibility-table">
<thead>
<tr class="magento-version">
Expand All @@ -30,12 +36,6 @@
{% endfor %}
</table>

**Stable**{: .status-light.stable } – version that has been tested by Magento as part of a Commerce release.

**Release&nbsp;candidate**{: .status-light.release-candidate } – version that has _not_ been tested by Magento as part of a Commerce release.

**Not&nbsp;supported**{: .status-light.not-supported } - version that is not compatible with a Commerce release.

<style>
.compatibility-table {
table-layout: auto;
Expand Down Expand Up @@ -71,11 +71,11 @@
margin: 0 12px;
}

.status-light.stable::before {
.status-light.general-availability::before {
background: rgb(45, 157, 120);
}

.status-light.release-candidate::before {
.status-light.open-beta::before {
background: rgb(230, 134, 25);
}

Expand Down
2 changes: 1 addition & 1 deletion guides/v2.1/install-gde/bk-install-guide.md
Expand Up @@ -24,7 +24,7 @@ It’s what we do.

## How to get the Magento software {#install-get-software}

Check the availability of exciting new features and releases, and learn how you can obtain them, on our [Magento 2.3 product availability page](https://devdocs.magento.com/release/#product-availability).
Check the availability of exciting new features and releases, and learn how you can obtain them, on our [Magento 2.3 product availability page](https://devdocs.magento.com/release/#availability).

Consult the following table for how to get started installing {{site.data.var.ce}} or {{site.data.var.ee}}.

Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/install-gde/bk-install-guide.md
Expand Up @@ -24,7 +24,7 @@ It’s what we do.

## How to get the Magento software {#install-get-software}

Check the availability of exciting new features and releases, and learn how you can obtain them, on our [Magento 2.3 product availability page](https://devdocs.magento.com/release/#product-availability).
Check the availability of exciting new features and releases, and learn how you can obtain them, on our [Magento 2.3 product availability page](https://devdocs.magento.com/release/#availability).

Consult the following table for getting started with installing {{site.data.var.ce}} or {{site.data.var.ee}}.

Expand Down
2 changes: 1 addition & 1 deletion guides/v2.3/release-notes/ReleaseNotes2.3.0Commerce.md
Expand Up @@ -45,7 +45,7 @@ Follow these steps to download and apply this patch:

* **CMS enhancements** include banner enhancements. You can now create banner content in native Magento WYSIWYG (or Page Builder. See the `Page Builder` discussion below. (Within the product interface, we now use the term “dynamic block” instead of “banner”.) We've also updated the WYSIWYG editor to use TinyMCE 4.6. (TinyMCE is now integrated into Magento through an adapter that allows it to be replaced with any other WYSIWYG editor.)

* **PageBuilder** is a drag-and-drop visual content editing tool that lets merchants customize the appearance of their storefront without writing any HTML or CSS. Registered participants can install PageBuilder Beta on Magento 2.3.0 Commerce code. See check [Magento 2.3 product availability](https://devdocs.magento.com/release/#product-availability) and [Magento blog](https://magento.com/blog/magento-news/magento-2.3-new-tools-fuel-your-growth-2019).
* **PageBuilder** is a drag-and-drop visual content editing tool that lets merchants customize the appearance of their storefront without writing any HTML or CSS. Registered participants can install PageBuilder Beta on {{site.data.var.ee}} 2.3.0 code. See check [Magento 2.3 product availability](https://devdocs.magento.com/release/#availability) and [Magento blog](https://magento.com/blog/magento-news/magento-2.3-new-tools-fuel-your-growth-2019).

### Improved developer experience

Expand Down
41 changes: 10 additions & 31 deletions release/index.md
@@ -1,50 +1,29 @@
---
layout: full-width
title: Magento product release information
title: Upcoming releases
group: release
---

Magento releases security and functional patches for each supported release line of {{site.data.var.ee}} every quarter.
Magento continually strives to find the right balance between making product upgrades simple and predictable and delivering improvements and new features to early adopters faster. Over the last year, we have refined how we deliver software to support this balance. For additional information, refer to our [release policy]({{site.baseurl}}/release/policy/).

The following guidelines apply to patch releases:
## Availability

- All supported versions receive security fixes.
- Newer versions receive full functional fixes and any enhancements. Fixes for high-severity functional issues are back-ported to older supported versions, but fixes for lower-severity issues are not necessarily back-ported.
- Changes that could break extensions or code compatibility are avoided. For example, code written for 2.2.0 should still work on 2.2.7.
- On an exceptional basis, breaking changes or additional patches or hotfixes may be released to address security issues. On the module level, these are mostly PATCH level changes, sometimes MINOR level changes.
- Patches may include new features as long as they are not expected to break other code. The new feature can be included in the core code or as an extension, such as Page Builder.

Magento releases a large (minor version change – 2.2.0 -> 2.3.0) update about once a year.

The following guidelines apply to minor releases:

- Breaking changes are possible; code written for 2.2.x may no longer work with 2.3.x. For example, minor releases can introduce support for major system requirements and dependencies, such as PHP.
- Module versions can vary. For example, some module changes are introduced in a new patch whereas others are introduced in a major release.
- Minor release can include new features that may require additional work from partners during upgrade to ensure compatibility.

{:.bs-callout .bs-callout-info}
See [Magento Software Lifecycle Policy] and [Versioning].

## Product availability
The following table describes the status of Magento software availability and where to get it, particularly for software that is available outside the conventional {{site.data.var.ee}} Composer package.

| Product | Availability | How to get it |
|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| **{{site.data.var.ee}} 2.3.1 GA** | Available now | [Composer](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html) |
| **{{site.data.var.ee}} 2.3.0 GA** | Available now | [Composer](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html) |
| **{{site.data.var.ee}} 2.3.1 GA** | Available now | [Composer](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html) |
| **{{site.data.var.ee}} 2.3.0 GA** | Available now | [Composer](https://devdocs.magento.com/guides/v2.3/install-gde/composer.html) |
| **{{site.data.var.ece}} Tools (aka ECE-Tools)** | Available now | [Composer](https://devdocs.magento.com/guides/v2.3/cloud/project/ece-tools-update.html) |
| **PWA Studio** | Available now (including support for {{site.data.var.ece}}) | [Documentation](https://magento-research.github.io/pwa-studio/) and [GitHub](https://github.com/magento-research/pwa-studio) |
| **Magento Shipping** | Available now | Merchants on Magento 2.2.2+ can use the [onboarding process](https://account.magento.com/shipping/onboarding/start) |
| **Page Builder** | Available now | Bundled with Magento Commerce 2.3.x |
| **Amazon Sales Channel** | Early access closed<br><br>Regional availability expected in first half of 2019 (US, Canada, Mexico)<br><br>EMEA and APAC availability expected in second half of 2019 | Magento Marketplace |
| **Google Shopping Ads Channel** | Early access May 2019<br><br>General availability expected in first half of 2019 | Magento Marketplace |
| **Google Shopping Ads Channel** | Early access May 2019<br><br>General availability expected in first half of 2019 | Magento Marketplace |

## Compatibility

## Extension stability
Magento modules that have been built to be decoupled from the {{site.data.var.ee}} core release process; this allows us to release iterations of these modules faster to merchants who are willing to accept a little risk in exchange for earlier access to new features.

The following table shows the release status of Magento extension versions relative to the 2.3.x release line of {{site.data.var.ee}}.

{% include compatibility.html data=site.data.compatibility %}

<!-- Link definitions -->

[Versioning]: https://devdocs.magento.com/guides/v2.3/extension-dev-guide/versioning/
[Magento Software Lifecycle Policy]: https://magento.com/sites/default/files/magento-software-lifecycle-policy.pdf
36 changes: 36 additions & 0 deletions release/policy/index.md
@@ -0,0 +1,36 @@
---
title: Release policy
group: release
---

{{site.data.var.ee}} uses [semantic versioning](https://semver.org/). For example:

- **MAJOR**—2
- **MINOR**—2.3
- **PATCH**—2.3.1

## MINOR release

Magento releases a large, minor version of {{site.data.var.ee}} about once a year.

The following guidelines apply to minor releases:

- Breaking changes are possible; code written for 2.2.x may no longer work with 2.3.x. For example, minor releases can introduce support for major system requirements and dependencies, such as PHP.
- Module versions can vary. For example, some module changes are introduced in a new patch whereas others are introduced in a major release.
- Minor releases can include new features that may require additional work from partners during upgrade to ensure compatibility.
- Minor releases can include fixes for security and compliance issues.

## PATCH release

Patch releases are primarily focused on delivering security and quality enhancements on a regular basis to help you keep your sites performing at their peak. Magento releases security and functional patches for each supported release line of {{site.data.var.ee}} every quarter.

The following guidelines apply to patch releases:

- All supported versions receive security fixes.
- Newer versions receive full functional fixes and enhancements.
- Changes that could break extensions or code compatibility are avoided. For example, code written for 2.2.0 should still work on 2.2.7.
- On an exceptional basis, breaking changes or additional patches or hotfixes may be released to address security or compliance issues. On the module level, these are mostly PATCH-level changes; sometimes MINOR-level changes.
- Patches may include new features as long as they are not expected to break other code. The new feature can be included in the core code or as an extension, such as Page Builder.

{:.bs-callout .bs-callout-info}
See [Magento Software Lifecycle Policy](https://magento.com/sites/default/files/magento-software-lifecycle-policy.pdf) and [Versioning](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/versioning/).

0 comments on commit 4fbdfa9

Please sign in to comment.