Merge branch 'master' into ok_tech-guidelines-factories

Author: dobooth

.github/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# DevDocs maintainer guidelines
+
+In general, the same [guidelines](https://devdocs.magento.com/guides/v2.3/contributor-guide/maintainers.html) for [`magento/magento2`](https://github.com/magento/magento2) maintainers apply to devdocs maintainers. However, there are some additional guidelines specific to devdocs that will help you as a maintainer.
+
+## General expectations
+
+- Self assign issues/pull requests (mostly pull requests)
+  - Review and approve or request changes
+  - Enforce the use of the issue/pull requests template
+  - Ask contributors to link to the code base to validate documentation updates when applicable
+  - Ask contributors not to contribute to v2.0 docs
+- If a maintainer creates a pull request, it should be reviewed by another maintainer or DevDocs staff member
+
+## Labels
+
+Labels are important because they help us identify pull requests and ensure that contributors receive points and recognition. See [devdocs awards and points](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#devdocs-awards-and-points).
+
+Here is a brief summary of the most important labels:
+
+- `New Topic`: Entirely new documents
+- `Major Update`: Significant new info: new section in existing topic, etc.
+- `Technical`: Changes to technical content/code/processes/naming conventions (any change to technical content)
+- `Editorial`: Typos, grammatical inconsistencies, or minor rewrites
+- `small changes`: See [Small changes workflow](#small-changes-workflow)
+
+We also use version labels when appropriate.
+
+As a maintainer, we expect you to add or remove labels when appropriate.
+
+See https://github.com/magento/devdocs/labels for all labels and their descriptions.
+
+## Testing
+
+Currently, we only test internal links. In the future, we plan to expand tests to include external links, markdown linting, and spell checking.
+
+We use private CI/CD stack and do not provide access to it.
+
+Every pull request to the `master` branch must pass tests before it can be merged. When a pull request is ready for tests, a member of the [`devdocs-admins`](https://github.com/orgs/magento/teams/devdocs-admins) team must add the test trigger phrase to the pull request as a comment. The trigger phrase is "_running tests_". By approving a pull request, you are signalling an admin that the pull request is ready for tests.
+
+## Projects
+
+We use several projects to help organize issues and pull requests. You can add existing issues and pull requests to these projects as you see fit.
+
+https://github.com/magento/devdocs/projects
+
+## Style
+
+We prefer Markdown over HTML (in most cases). You can use [kramdown](https://kramdown.gettalong.org/syntax.html) syntax for more markup features and [Liquid](https://jekyllrb.com/docs/liquid/) for in-topic scripting.
+
+## Small changes workflow
+
+Before merging a pull request to the `master` branch, it must pass automated testing. Testing takes about 30 minutes to complete for each pull request, so we created a workflow to save time for small changes.
+
+- **Individual pull requests to `master`**—15 individual pull requests to `master` x 30 minutes per pull request = 7.5 hrs of testing time
+- **Multiple pull requests using `small_changes`**—1 `small_changes` pull request (containing 15 individual pull requests) to `master` x 30 minutes = 30 minutes of testing time
+
+This workflow is for typos, formatting issues, and minor text additions or deletions. It is not for substantial new content, changes to tables, new files, or files that have been moved.
+
+Periodically, we will create a pull request from `small_changes` to `master` and then run tests on that pull request to save time.
+
+### Process
+
+1. Review the pull request and either approve it or request changes.
+1. Apply the `Small changes` label if one of the following labels should also be applied:
+
+   - `Editorial`
+   - `Technical`
+
+1. That's it! A devdocs-admin will run tests and merge.

.github/MAINTAINER_GUIDELINES.md

@@ -1,37 +1,31 @@
-## This PR is a:
+<!-- # IMPORTANT
 
-- [ ] New topic
-- [ ] Content update
-- [ ] Content fix or rewrite
-- [ ] Bug fix or improvement
+We are no longer accepting pull requests to update v2.1 devdoc files.
 
-## Summary
+Magento 2.1.18 is the final 2.1.x release. After the [June 2019 end-of-support date](https://magento.com/sites/default/files/magento-software-lifecycle-policy.pdf), Magento will no longer apply security patches, quality fixes, or documentation updates to v2.1.x. To maintain your site's performance, security, and PCI compliance, [upgrade](https://devdocs.magento.com/guides/v2.3/comp-mgr/bk-compman-upgrade-guide.html) to the latest version of Magento. -->
 
-When this pull request is merged, it will...
+## Purpose of this pull request
 
-<!-- (REQUIRED) What does this PR change? -->
+<!-- REQUIRED Describe the goal and the type of changes this pull request covers. -->
 
-## Additional information
+This pull request (PR) ...
 
-List all affected URLs 
+## Affected DevDocs pages
 
-- ...
-- ...
+<!-- REQUIRED List the affected pages on devdocs.magento.com (URLs). Not needed for large numbers of files. -->
 
-<!-- (REQUIRED) The Url that this PR will modify -->
+- ...
 
-<!-- (OPTIONAL) What other information can you provide about this PR? -->
+## Links to Magento source code
 
-<!--
-Thank you for your contribution!
+<!--  OPTIONAL - REMOVE THIS SECTION IF NOT USED. If this pull request references a file in a Magento codebase repository, add it here. -->
 
-Before submitting this pull request, please make sure you have read our Contribution Guidelines and your PR meets our contribution standards:
-https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
+- ...
 
-Please fill out as much information as you can about your PR to help speed up the review process.
-If your PR addresses an existing GitHub Issue, please refer to it in the title or Additional Information section to make the connection.
+<!-- 
+If you are fixing a GitHub issue, note it using GitHub keyword format (https://help.github.com/en/articles/closing-issues-using-keywords#closing-an-issue-in-a-different-repository) to close the issue when this pull request is merged. Example: `Fixes #1234`
 
-We may ask you for changes in your PR in order to meet the standards set in our Contribution Guidelines. PR's that do not comply with our guidelines may be closed at the maintainers' discretion.
+`master` is the default branch. Merged pull requests to `master` go live on the site automatically. Any requested changes to content on the `master` branch must be related to the released codebase. Any content related to future releases goes in the `develop` branch.
 
-Feel free to remove this section before creating this PR.
+See Contribution guidelines (https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md) for more information.
 -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,21 +2,16 @@
 ######################
 /*.db
 .DS_Store
+.vscode
 
 # Config and output files #
 ###########################
 
 /_site/
 
-/.*
-!/.github
-!/.github/**
-
-/*.yml
-!/_config.yml
-!/_config.prod.yml
-!/_config.checks.yml
-!/_config.stage.yml
+_config.local.yml
+.jekyll-metadata
+.whatsup.yml
 
 *.bat
 /tmp/
@@ -30,4 +25,12 @@ _algolia_api_key
 
 /mbi/
 /page-builder/
+/page-builder-migration/
 /guides/m1x/
+/mftf/
+
+# Docs from different branches #
+###################################
+
+/guides/v2.0/
+/guides/v2.1/

.gitignore

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

.mdlrc

@@ -0,0 +1,27 @@
+content_map:
+-
+  directory: guides/m1x
+  repository: magento/devdocs-m1
+  branch: master
+  filter: false
+-
+  directory: mbi
+  repository: magento/devdocs-mbi
+  branch: master
+  filter: true
+-
+  directory: mftf
+  repository: magento/magento2-functional-testing-framework
+  branch: master
+  filter: true
+-
+  directory: page-builder
+  repository: magento/magento2-page-builder
+  branch: 1.0-develop
+  filter: true
+-
+  directory: page-builder-migration
+  repository: magento/magento2-page-builder-data-migration
+  branch: 1.0.0-release
+  filter: true
+  

Docfile.yml

@@ -4,14 +4,21 @@ source 'https://rubygems.org'
 
 gem 'devdocs', git: 'https://github.com/magento-devdocs/devdocs-theme.git'
 gem 'jekyll'
+gem 'whatsup_github'
 
-gem 'wdm' if Gem.win_platform?
+gem 'wdm', platform: :mswin
 
 group :test do
   gem 'html-proofer'
+  gem 'mdl'
   gem 'launchy'
 end
 
+group :optimization do
+  gem 'image_optim'
+  gem 'image_optim_pack'
+end
+
 group :jekyll_plugins do
   gem 'jekyll-algolia', '~> 1.0'
   gem 'jekyll-redirect-from'

Gemfile

@@ -1,14 +1,14 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: dcb189be6fd4e0ebc69dce7cd6cdeb3b960b3a9e
+  revision: 5ce6bf94dbf827682b1f83d5e3c4fbc4c4f69478
   specs:
-    devdocs (0.0.1)
-      jekyll (~> 3.3)
+    devdocs (2)
+      jekyll (>= 3.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -23,16 +23,20 @@ GEM
       json (>= 1.5.1)
     colorator (1.1.0)
     colorize (0.8.1)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
     ethon (0.12.0)
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
-    ffi (1.10.0)
+    exifr (1.3.6)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.11.1)
     filesize (0.2.0)
     forwardable-extended (2.6.0)
+    fspath (3.1.1)
     html-proofer (3.9.3)
       activesupport (>= 4.2, < 6.0)
       addressable (~> 2.3)
@@ -46,7 +50,18 @@ GEM
     httpclient (2.8.3)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.5)
+    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.3)
+      fspath (>= 2.1, < 4)
+      image_optim (~> 0.19)
+    image_size (2.0.1)
+    in_threads (1.5.2)
+    jekyll (3.8.6)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -70,62 +85,87 @@ GEM
       verbal_expressions (~> 0.1.5)
     jekyll-optional-front-matter (0.3.0)
       jekyll (~> 3.0)
-    jekyll-redirect-from (0.14.0)
-      jekyll (~> 3.3)
+    jekyll-redirect-from (0.15.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-relative-links (0.6.0)
       jekyll (~> 3.3)
     jekyll-sass-converter (1.5.2)
       sass (~> 3.4)
-    jekyll-sitemap (1.2.0)
-      jekyll (~> 3.3)
+    jekyll-sitemap (1.3.1)
+      jekyll (>= 3.7, < 5.0)
     jekyll-titles-from-headings (0.5.1)
       jekyll (~> 3.3)
-    jekyll-watch (2.1.2)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
-    json (2.1.0)
+    json (2.2.0)
     kramdown (1.17.0)
     launchy (2.4.3)
       addressable (~> 2.3)
-    liquid (4.0.1)
+    liquid (4.0.3)
     listen (3.1.5)
       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)
       mini_portile2 (~> 2.3.0)
-    parallel (1.13.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    parallel (1.17.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    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.4)
-    sass (3.7.3)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      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)
       thread_safe (~> 0.1)
     verbal_expressions (0.1.5)
-    yell (2.0.7)
+    wdm (0.1.1)
+    whatsup_github (0.0.1)
+      netrc (~> 0.10)
+      octokit (~> 4.14)
+      thor (~> 0.20)
+    yell (2.2.0)
 
 PLATFORMS
   ruby
+  x86-mswin32
 
 DEPENDENCIES
   devdocs!
   html-proofer
+  image_optim
+  image_optim_pack
   jekyll
   jekyll-algolia (~> 1.0)
   jekyll-optional-front-matter
@@ -134,6 +174,9 @@ DEPENDENCIES
   jekyll-sitemap
   jekyll-titles-from-headings
   launchy
+  mdl
+  wdm
+  whatsup_github
 
 BUNDLED WITH
    1.17.3