Merge pull request #1 from magento/master

Merge Request

Author: kirtinariya1

.github/CONTRIBUTING.md

@@ -71,14 +71,14 @@ The following guidelines may answer most of your questions and help you get star
         For example:
 
         ```bash
-        git rm guides/v2.2/install-gde/composer.md
+        git rm guides/v2.3/install-gde/composer.md
         ```
 
         ```bash
-        cp guides/v2.1/install-gde/composer.md guides/v2.2/install-gde/composer.md
+        cp guides/v2.2/install-gde/composer.md guides/v2.3/install-gde/composer.md
         ```
 
-- Make sure that you update the correct version(s) of documentation (v2.1, v2.2, v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
+- Make sure that you update the correct version(s) of documentation (v2.2, v2.3). If you are not sure what directory to put your content in, just do your best. We can help re-locate it (if necessary) during the review process.
 - 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.
@@ -105,11 +105,11 @@ _(Optional)_ To review your changes in HTML output, follow the instructions in t
 
 We provide templates to help you get started writing new content and understanding Markdown formatting:
 
-- **General topic template** - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/basic_template.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html): This is a template for writing any topic with example formats and styles.
+- **General topic template** - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/basic_template.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/basic_template.html): This is a template for writing any topic with example formats and styles.
 - **Tutorial templates**: These templates provide example formats and styles for step-by-step instructions (like how-tos). Each file adds navigation buttons when content is generated. Templates include:
-  - First introduction topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-first.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-first.html): Introduction to a tutorial for prerequisites and listing steps
-  - Middle topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-middle.md) |  [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-middle.html): Use for each step in a tutorial.
-  - Final step topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.1/contributor-guide/templates/tutorial-template-last.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-last.html): Use for the last step of the tutorial.
+  - First introduction topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-first.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-first.html): Introduction to a tutorial for prerequisites and listing steps
+  - Middle topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-middle.md) |  [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-middle.html): Use for each step in a tutorial.
+  - Final step topic - [Markdown](https://github.com/magento/devdocs/blob/master/guides/v2.3/contributor-guide/templates/tutorial-template-last.md) | [HTML](https://devdocs.magento.com/guides/v2.3/contributor-guide/templates/tutorial-template-last.html): Use for the last step of the tutorial.
 
 ### Edit metadata
 

.gitignore

@@ -33,3 +33,4 @@ _algolia_api_key
 ###################################
 
 /guides/v2.0/
+/guides/v2.1/

.mdlrc

@@ -0,0 +1 @@
+style '_checks/md_style'

Gemfile

@@ -10,6 +10,7 @@ gem 'wdm', platform: :mswin
 
 group :test do
   gem 'html-proofer'
+  gem 'mdl'
   gem 'launchy'
 end
 

Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: 450a470aa4b937400190d009131fa91cf27d7a9d
+  revision: 5ce6bf94dbf827682b1f83d5e3c4fbc4c4f69478
   specs:
-    devdocs (0.0.1)
+    devdocs (2)
       jekyll (>= 3.3)
 
 GEM
@@ -33,10 +33,10 @@ GEM
     exifr (1.3.6)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    ffi (1.10.0)
+    ffi (1.11.1)
     filesize (0.2.0)
     forwardable-extended (2.6.0)
-    fspath (3.1.0)
+    fspath (3.1.1)
     html-proofer (3.9.3)
       activesupport (>= 4.2, < 6.0)
       addressable (~> 2.3)
@@ -50,18 +50,18 @@ GEM
     httpclient (2.8.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    image_optim (0.26.3)
+    image_optim (0.26.4)
       exifr (~> 1.2, >= 1.2.2)
       fspath (~> 3.0)
       image_size (>= 1.5, < 3)
       in_threads (~> 1.3)
       progress (~> 3.0, >= 3.0.1)
-    image_optim_pack (0.5.2.20190428)
+    image_optim_pack (0.5.3)
       fspath (>= 2.1, < 4)
       image_optim (~> 0.19)
     image_size (2.0.1)
-    in_threads (1.5.1)
-    jekyll (3.8.5)
+    in_threads (1.5.2)
+    jekyll (3.8.6)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -106,9 +106,16 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
+    mdl (0.5.0)
+      kramdown (~> 1.12, >= 1.12.0)
+      mixlib-cli (~> 1.7, >= 1.7.0)
+      mixlib-config (~> 2.2, >= 2.2.1)
     mercenary (0.3.6)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    mixlib-cli (1.7.0)
+    mixlib-config (2.2.18)
+      tomlrb
     multipart-post (2.1.1)
     netrc (0.11.0)
     nokogiri (1.8.5)
@@ -118,16 +125,16 @@ GEM
     parallel (1.17.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    progress (3.5.0)
-    progressbar (1.10.0)
-    public_suffix (3.0.3)
+    progress (3.5.1)
+    progressbar (1.10.1)
+    public_suffix (3.1.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
-    rouge (3.3.0)
+    rouge (3.5.1)
     ruby_dep (1.5.0)
     safe_yaml (1.0.5)
-    sass (3.7.3)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -137,6 +144,7 @@ GEM
       faraday (> 0.8, < 2.0)
     thor (0.20.3)
     thread_safe (0.3.6)
+    tomlrb (1.2.8)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
@@ -147,7 +155,7 @@ GEM
       netrc (~> 0.10)
       octokit (~> 4.14)
       thor (~> 0.20)
-    yell (2.1.0)
+    yell (2.2.0)
 
 PLATFORMS
   ruby
@@ -166,6 +174,7 @@ DEPENDENCIES
   jekyll-sitemap
   jekyll-titles-from-headings
   launchy
+  mdl
   wdm
   whatsup_github
 

README.md

@@ -13,7 +13,6 @@ Our goal is to provide the Magento community with comprehensive and quality tech
 You can build this site locally in the following ways:
 
 - [Installing the project dependencies locally](#build-using-jekyll) (Mac, Linux)
-
 - [Using a Vagrant virtual machine](#build-using-vagrant) (Mac, Linux, Windows)
 - [Build DevDocs in Windows](#build-devdocs-in-windows) (Windows 7 & 10)
 
@@ -42,12 +41,12 @@ $ ruby -v
 
 See the [Ruby site](https://www.ruby-lang.org/en/documentation/installation) for instructions.
 
-### Install Bundler
+### Upgrade RubyGems
 
-Install the [Bundler](https://bundler.io/) gem, which helps with Ruby dependencies:
+Upgrade [RubyGems](https://github.com/rubygems/rubygems), which helps with dependencies (gems):
 
 ```
-$ gem install bundler
+$ gem update --system
 ```
 
 Once you have completed preparing your environment, you can build locally and review the site in your browser.
@@ -178,6 +177,38 @@ To build v2.0 documentation:
     rake preview
     ```
 
+### To build v2.1 documentation
+
+Magento 2.1.18 was the final 2.1.x release. After June 2019, Magento 2.1.x stopped receiving security patches, quality fixes, and documentation updates.
+
+To ensure the quality of our public documentation for versions of Magento that are still supported and to avoid potential confusion about 2.1.x support, we removed all 2.1.x content from our public documentation websites on July 11, 2019.
+
+To build v2.1 documentation:
+
+> Also, you can use the GitHub interface to read the source Markdown files instead of building the site locally. Navigate to the [`2.1`](https://github.com/magento/devdocs/tree/2.1) branch and click the file you want to view.
+
+1. Add an entry for 2.1 in the `Docfile.yml` file.
+
+    ```yaml
+    -
+      directory: guides/v2.1
+      repository: magento/devdocs
+      branch: 2.1
+      filter: false
+    ```
+
+1. Initialize the `2.1` branch in your local devdocs repository.
+
+    ```shell
+    rake init
+    ```
+
+1. Run the preview command.
+
+    ```shell
+    rake preview
+    ```
+
 ## Build using Vagrant
 
 You can deploy the devdocs site locally using [this Vagrant project](https://github.com/magento-devdocs/vagrant-for-magento-devdocs).

Rakefile

@@ -62,7 +62,7 @@ desc 'Pull docs from external repositories'
 task init: %w[multirepo:init]
 
 desc 'Run checks (image optimization).'
-task check: %w[check:image_optim] 
+task check: %w[check:image_optim check:mdl] 
 
 desc 'Generate data for the weekly digest.'
 task :whatsnew do

_checks/md-check-hook.rb

@@ -0,0 +1,19 @@
+# This Jekyll hook runs Markdown linter (https://github.com/markdownlint/markdownlint)
+# on .md files that git tracks as 'modified' ('git ls-files -m').
+# '_checks/md_style' sets a style (https://github.com/markdownlint/markdownlint/blob/master/docs/creating_styles.md)
+# that is a set of rules to be applied when linting (https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md).
+# '.mdlrc' sets linting configuration (https://github.com/markdownlint/markdownlint/blob/master/docs/configuration.md).
+#
+# The plugin runs in serving mode only.
+#
+Jekyll::Hooks.register :site, :post_write do |site|
+  next unless site.config['serving']
+  staged_files = `git ls-files -m`.split("\n")
+  staged_md_files = staged_files.select { |file| File.extname(file) == '.md' }
+  next if staged_md_files.empty?
+  puts 'Checking Markdown syntax...'.blue
+  staged_md_files_as_a_string = staged_md_files.join(' ')
+  report = `bin/mdl #{staged_md_files_as_a_string}`
+  puts report.yellow
+  puts 'The style is defined in _checks/md_style'.yellow
+end

_checks/md_style

@@ -0,0 +1,41 @@
+# Approved style
+rule 'MD001'
+exclude_rule 'MD002'
+rule 'MD003', :style => :atx
+rule 'MD004'
+rule 'MD005'
+rule 'MD006'
+rule 'MD009'
+rule 'MD010'
+rule 'MD011'
+rule 'MD012'
+exclude_rule 'MD013'
+exclude_rule 'MD014'
+rule 'MD018'
+rule 'MD019'
+exclude_rule 'MD020'
+exclude_rule 'MD021'
+rule 'MD022'
+rule 'MD023'
+rule 'MD024', :allow_different_nesting => true
+rule 'MD025'
+
+# The following rules still require Docs team review and approval
+exclude_rule 'MD007'
+exclude_rule 'MD026'
+exclude_rule 'MD027'
+exclude_rule 'MD028'
+exclude_rule 'MD029'
+exclude_rule 'MD030'
+exclude_rule 'MD031'
+exclude_rule 'MD032'
+exclude_rule 'MD033'
+exclude_rule 'MD034'
+exclude_rule 'MD035'
+exclude_rule 'MD036'
+exclude_rule 'MD037'
+exclude_rule 'MD038'
+exclude_rule 'MD039'
+exclude_rule 'MD040'
+exclude_rule 'MD041'
+exclude_rule 'MD046'

_config.yml

@@ -19,9 +19,6 @@ baseurl: ""
 #
 version: "2.3"
 versions:
-   -
-      name: "2.1"
-      url: /guides/v2.1/
    -
       name: "2.2"
       url: /guides/v2.2/
@@ -102,11 +99,7 @@ defaults:
       group: module-reference-guide-2_3
       github_link: false
       feedback_link: false
-  -
-    scope:
-      path: guides/v2.1
-    values:
-      sitemap: false
+
   -
     scope:
       path: guides/v2.2
@@ -180,7 +173,7 @@ algolia:
   api_key: d2d0f33ab73e291ef8d88d8b565e754c
 
 google:
-  analytics: UA-66243208-1
+  gtm: GTM-KRCLXBB
 
 # Toggles the _plugin/html-check-hook.rb script that checks links in the generated HTML
 #
@@ -197,10 +190,6 @@ mage2bloburl: https://github.com/magento/magento2/blob
 m1xgdeurl: /guides/m1x
 m1xgithuburl: https://github.com/magento/devdocs/blob/master
 
-# 2.1 variables
-gdeurl21: /guides/v2.1/
-githuburl21: https://github.com/magento/devdocs/tree/master/guides/v2.1/
-
 # 2.2 variables
 gdeurl22: /guides/v2.2/
 githuburl22: https://github.com/magento/devdocs/tree/master/guides/v2.2/

_data/compatibility.yml

@@ -17,6 +17,20 @@ extension:
   -
     name: Google Shopping ads Channel
     versions:
+      -
+        name: 3.0.0
+        support:
+          2.2.4+: general availability
+          2.3.0: general availability
+          2.3.1: general availability
+          2.3.2: general availability
+      -
+        name: 2.0.2
+        support:
+          2.2.4+: general availability
+          2.3.0: general availability
+          2.3.1: general availability
+          2.3.2: general availability
       -
         name: 2.0.1
         support:

_data/toc/extension-best-practices.yml

@@ -57,3 +57,6 @@ pages:
 
         - label: Creating a Magento admin page
           url: /ext-best-practices/extension-coding/example-module-adminpage.html
+
+        - label: Creating a dynamic row system config
+          url: /ext-best-practices/tutorials/dynamic-row-system-config.html

_data/toc/javascript-developer-guide.yml

@@ -55,6 +55,9 @@ pages:
         - label: Confirmation widget
           url: /javascript-dev-guide/widgets/widget_confirm.html
 
+        - label: Dropdown widget
+          url: /javascript-dev-guide/widgets/widget_dropdown.html
+
         - label: DropdownDialog widget
           url: /javascript-dev-guide/widgets/widget_dialog.html
 
@@ -90,3 +93,6 @@ pages:
 
         - label: Tabs widget
           url: /javascript-dev-guide/widgets/widget_tabs.html
+
+        - label: ToggleAdvanced widget
+          url: /javascript-dev-guide/widgets/widget_toggle.html

_data/toc/rest-api.yml

@@ -5,13 +5,6 @@ pages:
 
     - label: Quick reference
       children:
-        - label: REST Endpoints (Swagger)
-          include_versions: ["2.0"]
-          url: http://devdocs.magento.com/swagger/index_20.html
-
-        - label: REST Endpoints (Swagger)
-          include_versions: ["2.1"]
-          url: http://devdocs.magento.com/swagger/index_21.html
 
         - label: REST Endpoints (Swagger)
           include_versions: ["2.2"]