fixing gem file issue

magento · Oct 15, 2018 · 28b3410 · 28b3410
2 parents d0c6af1 + d811e12
commit 28b3410
Show file tree

Hide file tree

Showing 3,111 changed files with 42,891 additions and 41,967 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -10,41 +10,43 @@ Working through the backlog takes time, though, so we appreciate your patience.
 ## Rewards for contributions
 
 DevDocs works with the Community Engineering teams and projects.
-As you contribute PRs, you gain [Contribution Points](https://github.com/magento/magento2/wiki/Contribution-Rewards).
+As you contribute PRs, you gain [Contribution Points](https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing.html#points).
 
 If you write and contribute a full topic, we will add your name (or your company's name) at the top of the DevDocs page and link it to your blog or website! We post your picture and a link to your GitHub account on the [Top recent contributors](https://devdocs.magento.com/guides/v2.2/contributor-guide/quarterly-contributors.html) page.
 
-## Get started
+## Prerequisites
 
-* Make sure you have a [GitHub account](https://github.com/signup/free). We recommend adding [Two-Factor Authentication](https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing.html#two-factor)(2FA) to your account. Partners are required to add 2FA protection when contributing to Magento respositories.
+* Make sure you have a [GitHub account](https://github.com/signup/free). We recommend adding [Two-Factor Authentication](https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing.html#two-factor)(2FA) to your account. Partners are required to add 2FA protection when contributing to Magento repositories.
 * Make sure you sign the [Magento Contributor Agreement](http://www.magento.com/legaldocuments/mca).
 * Check the [guidelines](#contribution-guidelines).
-* [Fork and clone](https://help.github.com/articles/fork-a-repo/) the [DevDocs repository](GitHub.com/magento/devdocs). [Sync](https://help.github.com/articles/syncing-a-fork/) as needed.
-* Write content and commit.  Need help, see our [templates](#templates).
-* Create a [pull request](https://help.github.com/articles/creating-a-pull-request/). Fill out as much info as possible and link any GitHub issues.
+* [Fork](https://help.github.com/articles/fork-a-repo/) or [clone](https://help.github.com/articles/cloning-a-repository/) the [DevDocs repository](GitHub.com/magento/devdocs). Remember to [sync your fork](https://help.github.com/articles/syncing-a-fork/) and update branches as needed.
 
 **Note:** If you have not signed the [Magento Contributor Agreement](http://www.magento.com/legaldocuments/mca), the PR will provide a link to complete. All contributors are required to submit the form and agree to the terms to complete it.
 
-**Tip![:]()** If you are not sure where to start contributing, check out our GitHub issues labeled [help wanted](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+**Tip!** If you are not sure where to start contributing, check out our GitHub issues labeled [help wanted](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) and [good first issue](https://github.com/magento/devdocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
 
 ## Contribution guidelines
 
-We use [Markdown](http://daringfireball.net/projects/markdown/) to write our documentation, which is a simple markup language that we convert to HTML using [Kramdown](http://kramdown.gettalong.org/syntax.html).
+Write content using [Kramdown](https://kramdown.gettalong.org/), which is a simple markup language. We use Kramdown, Liquid, and [Jekyll](https://jekyllrb.com/) to generate a static site hosted through [GH Pages](https://help.github.com/articles/what-is-github-pages/). Check [Templates](#templates) for examples of styles and markdown.
 
-You can update, or add content to, existing topics in their respective versioned directories (for 2.0, 2.1, 2.2, and onward).
+You can update existing or add new topics in their respective Magento 2 versioned directories (2.1, 2.2, 2.3, and onward). If you need help finding a directory for your content, we can help in your PR.
 
 The following guidelines may answer most of your questions and help you get started:
 
 1.  Check [existing pull requests](https://GitHub.com/magento/devdocs/pulls) and make sure you are not duplicating work!
 
-1.  For large contributions or changes that include multiple files, [open an issue](#report-an-issue) and discuss it with us first. This may further prevent duplicate or unnecessary effort.
+2.  For large contributions or changes that include multiple files, [open an issue](#report-an-issue) and discuss it with us first. This may further prevent duplicate or unnecessary effort.
 
-1.  Familiarize yourself with the existing documentation. Look through and search the guides to decide where to add your topics.
+3.  Familiarize yourself with the existing documentation. Look through and search the guides to decide where to add your topics.
 
     -   The DevDocs team can find the best home for your new topics and add it to the navigation.
-    -   If a topic has a symlink, you can remove it with git commands and add a new file. Copy and paste a previous version of the topic to get started.
+    -   If a topic has a symlink, you can remove it with Git commands and add a new file. Copy and paste a previous version of the topic to get started.
 
-1.  Focus on the content and on creating useful information for your fellow Magento developers and community members. Don't forget to review your work for typos, formatting errors, or sentences that need clarifying before opening a pull request.
+## Write and submit PRs
+
+1.  Create a branch and start writing content in existing or new files.
+
+1.  Focus on the content with useful information, code samples, and important notes for your fellow Magento developers and community members. Don't forget to review your work for typos, formatting errors, or sentences that need clarifying before opening a pull request.
 
 1.  Use the following guidelines to help you with the writing process:
 
@@ -54,14 +56,17 @@ The following guidelines may answer most of your questions and help you get star
     -   Remember to use active voice (not passive), write in the present tense, and use a friendly tone in second person. For example, _"The log captures commands, output..."_.
     -   Use notes to alert readers about important details.
     -   Use cross-references to other topics if appropriate. We can help you with the syntax if it is not clear. The template provides an example you can use.
+    -   Need help with markdown? See our [templates](#templates).
+
+1.  Create a [pull request](https://help.github.com/articles/creating-a-pull-request/). Fill out as much info as possible and link any GitHub issues. DevDocs and Maintainers will review the PR. Watch for comments and requests for changes. We will merge the content when ready with appropriate labels.
 
 ## Preview HTML locally
 
-To preview your changes in HTML output, follow the instructions in the [README](https://GitHub.com/magento/devdocs/blob/develop/README.md) to build the devdocs site locally using Jekyll.
+To preview your changes in HTML output, follow the instructions in the [README](https://GitHub.com/magento/devdocs/blob/master/README.md) to build the devdocs site locally using Jekyll.
 
 ## Templates
 
-Edit and add content to existing pages. For new topics, we provide templates to help get you started:
+We provide templates to help you 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.2/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:
@@ -71,14 +76,12 @@ Edit and add content to existing pages. For new topics, we provide templates to
 
 ### Edit metadata
 
-The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadata section is located at the top of each file.
+The Markdown (.md) file's metadata is a set of YAML key-value pairs. The metadata section is located at the top of each file. For more info, see the [Basic Template](https://devdocs.magento.com/guides/v2.2/contributor-guide/templates/basic_template.html).
 
 ```yaml
 ---
 group: install2
 title: Continue with your installation
-version: 2.1
-GitHub_link: install-gde/continue.md
 ---
 ```
 
@@ -89,8 +92,6 @@ GitHub_link: install-gde/continue.md
 | ------------- | -------------------------------------------------------------------------------------------------------------------- |
 | `group`       | Defines which guide the file belongs to and which left-hand menu collection the to use.                              |
 | `title`       | Sets the title of the page in the HTML meta and the main title on the page.                                          |
-| `version`     | Specifies which version(s) of Magento the topic affects. We also use this data to build links to the file on GitHub. |
-| `github_link` | Specifies the name and location of the source file in the GitHub repository.                                         |
 
 ## Report an issue
 
@@ -108,7 +109,7 @@ You have a couple of options to enter an issue:
 
 Have a question? Need help? Magento DevDocs, Maintainers, and other Contributors are available through:
 
-* [Slack](https://magentocommeng.slack.com/messages/CAN932A3H)
+* [Slack](https://magentocommeng.slack.com/messages/CAN932A3H) ([Join us](http://tinyurl.com/engcom-signup))
 * [Twitter @MagentoDevDocs](https://twitter.com/MagentoDevDocs)
 *	[E-mail](mailto:DL-Magento-Doc-Feedback@magento.com)
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,13 +13,20 @@ When this pull request is merged, it will...
 
 ## Additional information
 
+List all affected URLs 
+
+- ...
+- ...
+
+<!-- (REQUIRED) The Url that this PR will modify -->
+
 <!-- (OPTIONAL) What other information can you provide about this PR? -->
 
 <!--
 Thank you for your contribution!
 
 Before submitting this pull request, please make sure you have read our Contribution Guidelines and your PR meets our contribution standards:
-https://devdocs.magento.com/guides/v2.2/contributor-guide/contributing_docs.html
+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.

diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,7 @@
 
 /*.yml
 !/_config.yml
+!/_config.prod.yml
 
 *.bat
 *.sh

diff --git a/Dockerfile b/Dockerfile
diff --git a/Gemfile b/Gemfile
@@ -1,8 +1,15 @@
 source 'https://rubygems.org'
 
-gem 'github-pages', '183'
+gem 'github-pages'
+gem 'devdocs', :git => 'https://github.com/magento-devdocs/devdocs-theme.git', :branch => 'devdocs-stable'
+
 gem 'wdm' if Gem.win_platform?
-gem 'html-proofer'
-gem 'launchy'
 
-gem 'devdocs', :git => 'https://github.com/magento-devdocs/devdocs-theme.git', :branch => 'devdocs-stable'
+group :test do
+  gem 'html-proofer'
+  gem 'launchy'
+end
+
+group :jekyll_plugins do
+  gem 'jekyll-algolia', '~> 1.0'
+end
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,6 +14,7 @@ @@
     /*.yml
     !/_config.yml
+    !/_config.prod.yml
     *.bat
     *.sh
@@ Expand Down @@