Merge branch 'master' into Update-composer.json

Author: dobooth

.github/CONTRIBUTING.md

@@ -24,6 +24,8 @@ If you write and contribute a full topic, we will add your name (or your company
 1. [Fork](https://help.github.com/articles/fork-a-repo/) the [DevDocs repository](https://github.com/magento/devdocs). Remember to [sync your fork](https://help.github.com/articles/syncing-a-fork/) and update branches as needed.
 1. Review the [DevDocs guidelines](#contribution-guidelines).
 
+**Note:** If you use a fork instead of a branch, please set permissions to allow maintainers to edit and update the PR. See [Allowing changes to a pull request branch created from a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) in the _GitHub documentation_.
+
 ## Contribute documentation
 
 The following diagram shows the contribution workflow:
@@ -72,6 +74,8 @@ The following guidelines may answer most of your questions and help you get star
 -  Review your work for basic typos, formatting errors, or ambiguous sentences before opening a pull request.
 -  Revise pull requests according to review feedback. We will close pull requests that require an inordinate amount of time to review and process (especially for minor changes) if you fail to make revisions according to review feedback.
 -  Do not directly contact DevDocs team members or maintainers on Slack to review your pull request unless it has been open for more than five days. We have a process and queue for pull requests that everyone must follow.
+-  Get recognized on the DevDocs web site for writing new topics! Add your name and a link to your company website or GitHub profile to the file metadata so that we can display it on the page. See [Edit metadata](#edit-metadata).
+-  We no longer recognize individual community members who contribute features to the Magento 2 codebase in the corresponding feature topic(s) on the DevDocs website. Magento recognizes these contributions in more appropriate channels (for example, the [Magento DevBlog](https://community.magento.com/t5/Magento-DevBlog/bg-p/devblog)).
 
 ## Tips for writing content
 
@@ -108,8 +112,10 @@ The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadat
 ```yaml
 
 ---
-group: install2
-title: Continue with your installation
+group:
+title:
+contributor_name:
+contributor_link:
 ---
 ```
 
@@ -119,6 +125,8 @@ title: Continue with your installation
 | ------------- | ---------- |
 | `group`       | Defines the topic's guide or section. Use the table of contents `.yml` file name. This loads your left-side navigation. We will help during the PR process to add new files to the `.yml` file. |
 | `title`       | Sets the title of the page in the HTML metadata and the main title on the page.  |
+| `contributor_name` | Sets the name of the contributor who wrote the topic and displays it on the page. |
+| `contributor_link` | Creates a link to the contributor's GitHub profile or company website. |
 
 ## Report an issue
 

.gitignore

@@ -4,6 +4,7 @@
 .DS_Store
 .vscode
 .history
+/.idea
 
 # Config and output files #
 ###########################

Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: 13b0d9620c175368e9fcf4cb6bfa66afa569a54d
+  revision: c96131acc7a0ed03629ab3401c8a64d819e7e610
   specs:
-    devdocs (10)
+    devdocs (12)
       jekyll (>= 4.0)
 
 GEM
@@ -96,7 +96,7 @@ GEM
     jekyll-watch (2.2.1)
       listen (~> 3.0)
     json (2.3.0)
-    kramdown (2.2.1)
+    kramdown (2.3.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -153,7 +153,7 @@ GEM
     unicode-display_width (1.7.0)
     verbal_expressions (0.1.5)
     wdm (0.1.1)
-    whatsup_github (0.3.0)
+    whatsup_github (0.3.1)
       netrc (~> 0.10)
       octokit (~> 4.14)
       thor (~> 0.20)

_config.yml

@@ -9,10 +9,11 @@ description: Magento 2 Developer Documentation.
 # the base protocol and domain
 url: https://devdocs.magento.com
 
-# Site theme. https://jekyllrb.com/docs/themes/
+# Site theme: https://github.com/magento-devdocs/devdocs-theme
+# About themes in Jekyll: https://jekyllrb.com/docs/themes/
 theme: devdocs
 
-# Base url that forms 
+# A part of URL to be inserted between site.url and page.url
 baseurl: ""
 
 source: src
@@ -52,6 +53,18 @@ defaults:
       github_link: true
       # Enables the 'Give us feedback' appearances on pages
       feedback_link: true
+  
+  - 
+    scope:
+      path: guides/v2.3
+    values:
+      guide_version: '2.3'
+  
+  - 
+    scope:
+      path: guides/v2.4
+    values:
+      guide_version: '2.4'
 
   -
     scope:
@@ -132,11 +145,11 @@ defaults:
 # This list doesn't include custom plugins.
 #
 plugins:
-  - jekyll-sitemap
-  - jekyll-redirect-from
-  - jekyll-titles-from-headings
   - jekyll-optional-front-matter
+  - jekyll-redirect-from
   - jekyll-relative-links
+  - jekyll-sitemap
+  - jekyll-titles-from-headings
 
 optional_front_matter:
   remove_originals: true
@@ -145,19 +158,16 @@ optional_front_matter:
 # Exclude all .md directories and files except page-builder/ to prevent painfully long build times.
 
 relative_links:
+  enabled:     true
+  collections: false
   exclude:
-    - _includes
-    - _videos
+    - 404.md
     - codelinks
     - community
     - extensions
     - guides
     - redoc
     - release
-    - 404.md
-    - availability.md
-    - magento-techbull.md
-    - magento-third-party.md
     - search
     - system-requirements.md
     - whats-new.md
@@ -199,16 +209,11 @@ check_links: true
 # Variables #
 #############
 #
-# Magento 2 repository variable
+# Magento 2 repository
 mage2bloburl: https://github.com/magento/magento2/blob
 
 # Current version
 gdeurl: /guides/v2.4
-githuburl: https://github.com/magento/devdocs/tree/master/src/guides/v2.4
-
-# 2.3 variables
-gdeurl23: /guides/v2.3/
-githuburl23: https://github.com/magento/devdocs/tree/master/src/guides/v2.3/
 
 # Path to S3 location where we store large downloadable binary files, such as .ai, .psd, .zip, .pdf, .sketch
 downloads: https://devdocs.magento.com/download

_plugins/page-params/page-baseurl-generator.rb

@@ -6,29 +6,19 @@
 # This custom plugin dynamically sets and injects the page.baseurl variable
 # based on the page's destination.
 #
-# The hook introduces the page.baseurl and
-# page.guide_version data parameters for each page.
+# The hook introduces the page.baseurl parameter for each page.
 # For pages at guides/v2.x the page.baseurl parameter is set
 # as "{site.baseurl}/guides/v#{version}".
 # The {version} is taken from the 'guide_version' front matter parameter on the page;
-# if it is not set, then the 'guide_version' is set to version from the page path (for example, "2.2" in the "guides/v2.2/**/*.md");
-# if the path doesn't contain "guides/v2.x", then the version is unset and returns the nil object (same as null)
+# if it is not set, then the 'guide_version' is set to version from the _config.yml depending on a scope by path (for example, "2.4" at the "guides/v2.4/");
+# otherwise, the version is unset and returns the nil object (same as null).
 Jekyll::Hooks.register :pages, :post_init do |page|
   # Glossary. Create and assign variables to be used in the script.
-  pattern = %r{\Aguides/v(?<version_from_path>2\.\d)}
   baseurl = page.site.baseurl
-  path = page.path
   data = page.data
   version = data['guide_version']
 
-  # Process 'page.guide_version' pararmeter
-  if version.nil? && path.start_with?('guides')
-    pattern.match(path)
-    version = Regexp.last_match(:version_from_path)
-    data['guide_version'] = version
-  end
-
-  # Process 'page.baseurl' parameter
+  # Create 'page.baseurl' parameter
   data['baseurl'] =
     if version
       "#{baseurl}/guides/v#{version}"

src/_data/codebase/cloud/cloud-error-messages.yml

@@ -511,8 +511,8 @@ pages:
           url: /cloud/live/stage-prod-test.html
           versionless: true
 
-        - label: Error log message reference
-          url: /cloud/reference/error-codes.html
+        - label: Error message reference for ece-tools
+          url: /cloud/reference/ece-tools-error-reference.html
           versionless: true
 
     - label: Site launch

src/_data/toc/cloud-guide.yml

@@ -20,10 +20,6 @@ pages:
           url: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
           versionless: true
 
-        - label: Suggested topics for contribution
-          url: /contributor-guide/contributing_docs_suggested.html
-          versionless: true
-
         - label: Templates
           children:
             - label: Basic template

src/_data/toc/contributor-guide.yml

@@ -5,34 +5,60 @@ pages:
       url: /marketplace/eqp/v1/api.html
       versionless: true
 
-    - label: Authentication
-      url: /marketplace/eqp/v1/auth.html
+    - label: Getting started
+      url: /marketplace/eqp/v1/getting-started.html
       versionless: true
+      children:
+      
+        - label: Sandbox
+          url: /marketplace/eqp/v1/sandbox.html
+          versionless: true
 
-    - label: Users
-      url: /marketplace/eqp/v1/users.html
-      versionless: true
+        - label: API access keys
+          url: /marketplace/eqp/v1/access-keys.html
+          versionless: true
 
-    - label: Files
-      url: /marketplace/eqp/v1/files.html
+    - label: REST API
+      url: /marketplace/eqp/v1/rest-api.html
       versionless: true
+      children:
 
-    - label: Packages
-      url: /marketplace/eqp/v1/packages.html
-      versionless: true
+        - label: Authentication
+          url: /marketplace/eqp/v1/auth.html
+          versionless: true
 
-    - label: Test results
-      url: /marketplace/eqp/v1/test-results.html
-      versionless: true
+        - label: Users
+          url: /marketplace/eqp/v1/users.html
+          versionless: true
 
-    - label: Reports
-      url: /marketplace/eqp/v1/reports.html
-      versionless: true
+        - label: Files
+          url: /marketplace/eqp/v1/files.html
+          versionless: true
 
-    - label: Filtering
-      url: /marketplace/eqp/v1/filtering.html
-      versionless: true
+        - label: Packages
+          url: /marketplace/eqp/v1/packages.html
+          versionless: true
+
+        - label: Test results
+          url: /marketplace/eqp/v1/test-results.html
+          versionless: true
+
+        - label: Reports
+          url: /marketplace/eqp/v1/reports.html
+          versionless: true
+
+        - label: API callbacks
+          url: /marketplace/eqp/v1/callbacks.html
+          versionless: true
+
+        - label: Filtering
+          url: /marketplace/eqp/v1/filtering.html
+          versionless: true
+
+        - label: Handling errors
+          url: /marketplace/eqp/v1/handling-errors.html
+          versionless: true
 
-    - label: API callbacks
-      url: /marketplace/eqp/v1/callbacks.html
+    - label: Getting help
+      url: /marketplace/eqp/v1/help.html
       versionless: true