Skip to content

Commit

Permalink
Merge branch '2.4.7-develop' into 2.4.7-beta3-release-notes-1120
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-matthews authored and GitHub Enterprise committed Mar 5, 2024
2 parents 5504b26 + e36fe50 commit 0db88c5
Show file tree
Hide file tree
Showing 105 changed files with 3,343 additions and 813 deletions.
74 changes: 62 additions & 12 deletions README.md
Expand Up @@ -14,7 +14,7 @@ How you contribute depends on who you are and the sort of changes you'd like to

### Minor changes

If you are contributing minor updates out of the goodness of your heart, visit the article and click the **Edit** link in the article that goes to the GitHub source for the article. Then, just use the GitHub UI to make your updates. See the general [Adobe Docs contributor guide](https://experienceleague.adobe.com/docs/contributor/contributor-guide/introduction.html) for more information.
If you are contributing minor updates, visit the article and click the feedback area that appears at the bottom of the article, click **Detailed feedback options**, and then click **Suggest an edit** to go to the markdown source file on GitHub. Use the GitHub UI to make your updates. See the general [Adobe Docs contributor guide](https://experienceleague.adobe.com/docs/contributor/contributor-guide/introduction.html) for more information.

Minor corrections or clarifications you submit for documentation and code examples in this repo are covered by the Adobe terms of use.

Expand Down Expand Up @@ -47,25 +47,75 @@ All the articles in this repository use GitHub flavored markdown. If you are not

## Templates

The `_jekyll` directory contains templated topics and required assets.
The templates that use the Liquid templating language reside in the `_jekyll/templated` directory as HTML files.
The `_jekyll/_data` directory contains files with the data that is used to render the templates.
For some topics, we use data files and templates to generate published content. Use cases for this approach include:

To render all templates:
* Publishing large sets of programmatically generated content
* Providing a single source of truth for customers across multiple systems that require machine-readable file formats, such as YAML, for integration (e.g., Site-Wide Analysis Tool)

Examples of templated content include, but are not limited to, the following:

* [CLI tools reference](https://experienceleague.adobe.com/docs/commerce-operations/reference/commerce-on-premises.html)
* [Product availability tables](https://experienceleague.adobe.com/docs/commerce-operations/release/product-availability.html)
* [System requirements tables](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html)

### Generate templated content

In general, most writers only need to add a release version to the product availability and system requirements tables. Maintenance for all other templated content is either automated or managed by a dedicated team member. These instructions are intended for "most" writers.

>**NOTE:**
>
>* Generating templated content requires working on the command line in a terminal.
>* You must have Ruby installed to run the rendering script. See [_jekyll/.ruby-version](_jekyll/.ruby-version) for the required version.
See the following for a description of the file structure for templated content:

* `_jekyll`—Contains templated topics and required assets
* `_jekyll/_data`—Contains the machine-readable file formats used to render templates
* `_jekyll/templated`—Contains HTML-based template files that use the Liquid templating language
* `help/_includes/templated`—Contains the generated output for templated content in `.md` file format so it can be published in Experience League topics; the rendering script automatically writes generated output into this directory for you

To update templated content:

1. In your text editor, open a data file in the `/jekyll/_data` directory. For example:

* [Product availability tables](https://experienceleague.adobe.com/docs/commerce-operations/release/product-availability.html): `/jekyll/_data/product-availability.yml`
* [System requirements tables](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html): `/jekyll/_data/system-requirements.yml`

1. Use the existing YAML structure to create entries.

For example, to add a version of Adobe Commerce to the product availability tables, add the following to each entry in the `extensions` and `services` sections of the `/jekyll/_data/product-availability.yml` file (modify version numbers as needed):

```
support:
- core: 1.2.3
version: 4.5.6
```

1. Navigate to the `_jekyll` directory.

```
cd _jekyll
```

1. Generate templated content and write the output to the `help/_includes/templated` directory.

```
rake render
```

>**NOTE:** You must run the script from the `_jekyll` directory. If this is your first time to run the script, you must install Ruby dependencies first with the `bundle install` command.
1. Run the rendering script.
1. Verify that the expected `help/_includes/templated` files were modified.

```
_scripts/render
```
```
git status
```

> **NOTE:** You must run the script from the `_jekyll` directory.
> **NOTE:** You must have Ruby installed to run this script.
You should see output similar to the following:

The script runs rendering and writes rendered templates to the `help/_includes/templated` directory.
```
modified: _data/product-availability.yml
modified: ../help/_includes/templated/product-availability-extensions.md
```

See the Jekyll documentation for more details on [Data Files](https://jekyllrb.com/docs/datafiles), [Liquid filters](https://jekyllrb.com/docs/liquid/filters/), and other features.
2 changes: 1 addition & 1 deletion _jekyll/.ruby-version
@@ -1 +1 @@
3.2.2
3.3.0
2 changes: 1 addition & 1 deletion _jekyll/Gemfile
Expand Up @@ -4,5 +4,5 @@ source 'https://rubygems.org'

gem 'jekyll'
gem 'rake'
gem 'whatsup_github'
gem 'whatsup_github', git: 'https://github.com/commerce-docs/whatsup_github', branch: 'main'
gem 'faraday-retry'
62 changes: 35 additions & 27 deletions _jekyll/Gemfile.lock
@@ -1,27 +1,39 @@
GIT
remote: https://github.com/commerce-docs/whatsup_github
revision: d21e902360deda9efbef9f7783b8b73f19fc7fa9
branch: main
specs:
whatsup_github (1.1.0)
netrc (~> 0.11)
octokit (~> 8.0)
thor (~> 1.3)

GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
addressable (2.8.6)
public_suffix (>= 2.0.2, < 6.0)
base64 (0.2.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
faraday (2.7.3)
faraday (2.8.1)
base64
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
faraday-retry (2.0.0)
faraday-retry (2.2.0)
faraday (~> 2.0)
ffi (1.15.5)
ffi (1.16.3)
forwardable-extended (2.6.0)
google-protobuf (3.21.12)
google-protobuf (3.25.1)
http_parser.rb (0.8.0)
i18n (1.12.0)
i18n (1.14.1)
concurrent-ruby (~> 1.0)
jekyll (4.3.1)
jekyll (4.3.3)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
Expand Down Expand Up @@ -51,37 +63,33 @@ GEM
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
netrc (0.11.0)
octokit (6.0.1)
octokit (8.0.0)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.1)
rake (13.0.6)
public_suffix (5.0.4)
rake (13.1.0)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (4.0.1)
rexml (3.2.6)
rouge (4.2.0)
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass-embedded (1.57.1)
google-protobuf (~> 3.21)
rake (>= 10.0.0)
sass-embedded (1.57.1-arm64-darwin)
google-protobuf (~> 3.21)
sass-embedded (1.69.7)
google-protobuf (~> 3.25)
rake (>= 13.0.0)
sass-embedded (1.69.7-arm64-darwin)
google-protobuf (~> 3.25)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
thor (1.2.1)
unicode-display_width (2.4.2)
webrick (1.7.0)
whatsup_github (1.0.1)
netrc (~> 0.11)
octokit (~> 6.0)
thor (~> 1.2)
thor (1.3.0)
unicode-display_width (2.5.0)
webrick (1.8.1)

PLATFORMS
arm64-darwin-22
Expand All @@ -92,7 +100,7 @@ DEPENDENCIES
faraday-retry
jekyll
rake
whatsup_github
whatsup_github!

BUNDLED WITH
2.1.4
2.5.3
162 changes: 162 additions & 0 deletions _jekyll/_data/product-availability.yml
@@ -0,0 +1,162 @@
---
# This file is being used in SWAT automation. Follow existing format to avoid breaking changes.
# If breaking changes cannot be omitted, communicate with the SWAT team prior to introducing them.

extensions:
Adobe I/O Events for Adobe Commerce:
docs:
Composer: https://developer.adobe.com/commerce/extensibility/events/installation/
Release Notes: https://developer.adobe.com/commerce/extensibility/events/release-notes/
support:
- core: 2.4.7-beta2
version: 1.3.0
- core: 2.4.6
version: 1.3.0
- core: 2.4.5
version: 1.3.0
- core: 2.4.4
version: 1.3.0
B2B:
docs:
Composer: https://experienceleague.adobe.com/docs/commerce-admin/b2b/install.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-admin/b2b/release-notes.html
support:
- core: 2.4.7-beta2
version: 1.4.2
- core: 2.4.6
version: 1.3.5+
- core: 2.4.5
version: 1.3.4
- core: 2.4.4
version: 1.3.3
Experience Platform Connector:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-experience-platform-connector.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/experience-platform-connector/release-notes.html
support:
- core: 2.4.7-beta2
version: 3.0.0-beta1
- core: 2.4.6
version: 1.0.0+
- core: 2.4.5
version: 1.0.0+
- core: 2.4.4
version: 1.0.0+
Page Builder:
docs:
User Guide: https://experienceleague.adobe.com/docs/commerce-admin/page-builder/guide-overview.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-admin/page-builder/release-notes.html
support:
- core: 2.4.7-beta2
version: '-'
- core: 2.4.6
version: 1.7.3
- core: 2.4.5
version: 1.7.2
- core: 2.4.4
version: 1.7.1
services:
Amazon Sales Channel:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-module-amazon.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-channels/amazon/release-notes.html
support:
- core: 2.4.7-beta2
version: '-'
- core: 2.4.6
version: 4.4.0+
- core: 2.4.5
version: 4.3.0+
- core: 2.4.4
version: 4.3.0+
Catalog Service for Adobe Commerce:
docs:
Overview: https://experienceleague.adobe.com/docs/commerce-merchant-services/catalog-service/guide-overview.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/catalog-service/release-notes.html
support:
- core: 2.4.7-beta2
version: 1.17
- core: 2.4.6
version: 1.17
- core: 2.4.5
version: 1.17
- core: 2.4.4
version: 1.17
Channel Manager:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-channel-manager.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-channels/channel-manager/release-notes.html
support:
- core: 2.4.7-beta2
version: 2.1.0
- core: 2.4.6
version: 2.0.0
- core: 2.4.5
version: 1.0.0+
- core: 2.4.4
version: 1.0.0+
Live Search:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-live-search.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/live-search/release-notes.html
support:
- core: 2.4.7-beta2
version: 4.1.0
- core: 2.4.6
version: 4.1.0
- core: 2.4.5
version: 4.1.0
- core: 2.4.4
version: 4.1.0
Payment Services:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-payment-services.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/payment-services/release-notes.html
support:
- core: 2.4.7-beta2
version: 2.3.0
- core: 2.4.6
version: 2.2.0
- core: 2.4.5
version: 2.2.0 (PHP 8.1)
- core: 2.4.4
version: 2.2.0 (PHP 8.1)
Product Recommendations:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-product-recommendations.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/product-recommendations/release-notes.html
support:
- core: 2.4.7-beta2
version: 6.0.0
- core: 2.4.6
version: 6.0.0
- core: 2.4.5
version: 6.0.0
- core: 2.4.4
version: 6.0.0
Quick Checkout:
docs:
Marketplace: https://commercemarketplace.adobe.com/magento-quick-checkout.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/product-recommendations/release-notes.html
support:
- core: 2.4.7-beta2
version: '-'
- core: 2.4.6
version: 1.0.0+
- core: 2.4.5
version: 1.2.0+
- core: 2.4.4
version: 1.0.0+
Store Fulfillment for Adobe Commerce:
docs:
Marketplace: https://commercemarketplace.adobe.com/store-fulfillment-magento-walmart.html
Release Notes: https://experienceleague.adobe.com/docs/commerce-merchant-services/store-fulfillment/release-notes.html
support:
- core: 2.4.7-beta2
version: '-'
- core: 2.4.6
version: 1.5.0
- core: 2.4.5
version: 1.2.0+
- core: 2.4.4
version: 1.2.0+

0 comments on commit 0db88c5

Please sign in to comment.