Merge branch 'develop' of https://github.com/magento/devdocs_internal …

…into functional_areas # Conflicts: # common/js/app.min.js # css/app.css
magento · Oct 30, 2017 · a0f08f3 · a0f08f3
2 parents 70a1148 + b7c5fcd
commit a0f08f3
Show file tree

Hide file tree

Showing 834 changed files with 3,576 additions and 870 deletions.
diff --git a/_data/toc/cloud-guide.yml b/_data/toc/cloud-guide.yml
@@ -74,16 +74,17 @@ pages:
 
         - label: Import an existing Magento project
           children:
-            - label: First steps for importing Magento EE
+
+            - label: First steps for importing Magento Commerce
               url: cloud/access-acct/first-time-setup_import-first-steps.html
 
             - label: Find the information you need for your import
               url: cloud/access-acct/first-time-setup_import-prereq.html
 
-            - label: Prepare your existing Magento EE system
+            - label: Prepare your existing Magento Commerce system
               url: cloud/access-acct/first-time-setup_import-prepare.html
 
-            - label: Import Magento EE into Magento Enterprise Cloud Edition
+            - label: Import Magento Commerce into Magento Commerce (Cloud)
               url: cloud/access-acct/first-time-setup_import-import.html
 
     - label: Configure Magento Commerce (Cloud)
@@ -99,12 +100,16 @@ pages:
           url: cloud/live/paypal-onboarding.html
           versions: ["2.1","2.2","2.3"]
 
-        - label: Set up multiple Cloud websites or stores
-          url: cloud/project/project-multi-sites.html
+        - label: Set up Magento B2B
+          url: cloud/configure/setup-b2b.html
+          versions: ["2.2","2.3"]
 
         - label: Set up cron jobs
           url: cloud/configure/setup-cron-jobs.html
 
+        - label: Set up multiple Cloud websites or stores
+          url: cloud/project/project-multi-sites.html
+
         - label: .magento.app.yaml
           url: cloud/project/project-conf-files_magento-app.html
 
@@ -143,6 +148,15 @@ pages:
             - label: Set up RabbitMQ service
               url: cloud/project/project-conf-files_services-rabbit.html
 
+    - label: Fastly
+      url: cloud/basic-information/cloud-fastly.html
+      children:
+        - label: Set up Fastly
+          url: cloud/access-acct/fastly.html
+
+        - label: Custom Fastly VCL snippets
+          url: cloud/configure/cloud-vcl-custom-snippets.html
+
     - label: Manage your project
       url: cloud/project/projects.html
       children:

diff --git a/_data/toc/configuration-guide.yml b/_data/toc/configuration-guide.yml
@@ -172,7 +172,7 @@ pages:
             - label: Other configuration paths reference
               url: config-guide/prod/config-reference-most.html
 
-            - label: Magento Enterprise B2B Extension configuration paths reference
+            - label: Magento Commerce for B2B Extension configuration paths reference
               url: config-guide/prod/config-reference-b2b.html
 
             - label: .gitignore reference

diff --git a/_data/toc/installation-guide.yml b/_data/toc/installation-guide.yml
@@ -126,10 +126,10 @@ pages:
             - label: Install Composer
               url: install-gde/prereq/integrator_install_composer.html
 
-            - label: Get the Magento CE metapackage
+            - label: Get the Magento Open Source metapackage
               url: install-gde/prereq/integrator_install_ce.html
 
-            - label: Get the Magento EE metapackage
+            - label: Get the Magento Commerce metapackage
               url: install-gde/prereq/integrator_install_ee.html
 
         - label: (Contributor) Clone the Magento repository

diff --git a/_data/toc/php-developer-guide.yml b/_data/toc/php-developer-guide.yml
@@ -111,7 +111,7 @@ pages:
         - label: How to add CLI commands
           url: extension-dev-guide/cli-cmds/cli-howto.html
 
-    - label: Staging (Enterprise Edition only)
+    - label: Staging (Magento Commerce only)
       versions: ["2.1","2.2", "2.3"]
       url: extension-dev-guide/staging.html
 
@@ -168,7 +168,7 @@ pages:
             - label: Adding a custom indexer
               url: extension-dev-guide/indexing-custom.html
 
-        - label: Message Queues (Enterprise Edition Only)
+        - label: Message Queues (Magento Commerce Edition Only)
           children:
 
             - label: Message queues overview

diff --git a/_data/toc/rest-api.yml b/_data/toc/rest-api.yml
@@ -42,14 +42,14 @@ pages:
           url: rest/notes.html
 
     - label: Modules
-      versions: ["2.2", "2.3"]
       children:
 
         - label: Catalog
           children:
 
-            - label: Manage prices for multiple products
-              url: rest/catalog-pricing.html
+            - label: General notes
+              url: rest/modules/catalog.html
 
-            - label: Usage notes
-              url: rest/catalog-notes.html
+            - label: Manage prices for multiple products
+              url: rest/modules/catalog-pricing.html
+              versions: ["2.2", "2.3"]
diff --git a/_data/toc/software-update-guide.yml b/_data/toc/software-update-guide.yml
@@ -122,7 +122,7 @@ pages:
         - label: Install the B2B extension
           url: comp-mgr/install-extensions/b2b-installation.html
 
-    - label: Upgrade from CE to EE
+    - label: Upgrade from Magento Open Source to Magento Commerce
       url: comp-mgr/upgrader/ce-ee-upgrade-start.html
 
     - label: Command-line upgrade
@@ -200,7 +200,7 @@ pages:
         - label: Troubleshoot backups
           url: comp-mgr/trouble/cman/tshoot_backup.html
 
-        - label: Error upgrading from CE to EE
+        - label: Error upgrading from Magento Open Source to Magento Commerce
           url: comp-mgr/trouble/cman/ce-ee-upgrade.html
 
         - label: magento/theme-doc-blank failure

diff --git a/_includes/cloud/ssh-tunnel.md b/_includes/cloud/ssh-tunnel.md
@@ -0,0 +1,53 @@
+<div markdown="1">
+
+You can also use SSH tunneling to connect to a service from your local development environment as if the service were local. Before tunneling, you need to have [SSH configured]({{ page.baseurl }}cloud/env/environments-ssh.html).
+
+Use a terminal application to log in and issue commands.
+
+  magento-cloud login
+
+First, you may want to check if any tunnels are already open using the following command:
+
+	magento-cloud tunnel:list
+
+To build a tunnel, you must know the name of the app to which to tunnel. Use the following commands to list those applications:
+
+	cd <project directory>
+	magento-cloud project:list
+	magento-cloud apps
+
+For information on the command, you can enter `magento-cloud apps --help`.
+
+### Set up the SSH tunnel {#tunnel-setup}
+Use the following command:
+
+	magento-cloud tunnel:open -e <environment ID> --app <app name>
+
+For example, to open a tunnel to the `sprint5` branch in a project with an app named `mymagento`, enter
+
+	magento-cloud tunnel:open -e sprint5 --app mymagento
+
+Messages similar to the following display:
+
+	SSH tunnel opened on port 30003 to relationship: solr
+	SSH tunnel opened on port 30004 to relationship: redis
+	SSH tunnel opened on port 30005 to relationship: database
+	Logs are written to: /home/magento_user/.magento/tunnels.log
+
+	List tunnels with: magento-cloud tunnels
+	View tunnel details with: magento-cloud tunnel:info
+	Close tunnels with: magento-cloud tunnel:close
+
+### Get tunnel information {#tunnel-info}
+To display information about your tunnel, enter:
+
+	magento-cloud tunnel:info -e <environment ID>
+
+### Connect to services {#tunnel-services}
+Now you can connect to services as if they were running locally.
+
+For example, to connect to the database, use the following command:
+
+	mysql --host=127.0.0.1 --user='<database user name>' --pass='<user password>' --database='<name>' --port='<port>'
+
+Details about the service display if you use the `magento-cloud tunnel:info` command.
diff --git a/_includes/cloud/wings-management.md b/_includes/cloud/wings-management.md
@@ -1,8 +1,9 @@
 <div markdown="1">
 
 <div class="bs-callout bs-callout-info" id="info" markdown="1">
-**Updating your Pro project**
-These sections include instructions for Pro projects updated to manage Staging and Production through the Project Web Interface. For more information adding this management to existing Pro projects (created before October 23, 2017), see [Add Staging and Production to Pro projects UI]({{page.baseurl}}cloud/trouble/pro-env-management.html).
+**Updating your Pro project**: These sections include instructions for Pro projects with Staging and Production available in the Project Web Interface. To add Staging and Production to your interface, see [Add Staging and Production to Pro projects UI]({{page.baseurl}}cloud/trouble/pro-env-management.html).
+
+We can update Pro projects created before October 23, 2017. All new Pro projects include these features. Your ticket will be queued for update, which may take time to complete. We will keep you updated through the process.
 
 If you do not request this update, you must use CLI commands or tickets to modify settings, variables, routes, and more for Pro plan Staging and Production environments.
 </div>
diff --git a/_layouts/search.md b/_layouts/search.md
@@ -6,12 +6,21 @@
 
 <div class="search-results container">
 
-  <div id="stats"></div>
-  <div id="hits"></div>
-  <div id="pagination"></div>
+  <article>
+    <div id="stats"></div>
+    <div id="hits"></div>
+  </article>
+
+  <aside>
+    <div id="tags"></div>
+  </aside>
 
 </div><!-- container -->
 
+<div class="search-results-footer">
+  <div id="pagination"></div>
+</div>
+
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.css">
 <script src="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.js"></script>
 
@@ -25,22 +34,27 @@
   });
 
 
-
   function app(opts) {
     var switcher = document.getElementsByClassName('version-switcher')[0];
-    var ver = String( switcher.dataset.version );
+    var searchParameters = {
+
+    };
+
+    if ( switcher ) {
+      var ver = String( switcher.dataset.version );
+      searchParameters.facets = ['guide_version'];
+      searchParameters.facetsRefinements = {
+        guide_version: [ ver ]
+      };
+    }
+
+
     const search = instantsearch({
       appId: opts.appId,
       apiKey: opts.apiKey,
       indexName: opts.indexName,
       urlSync: true,
-      searchParameters: {
-
-        facetsRefinements: {
-          guide_version: [ ver ],
-        },
-        facets: ['guide_version'],
-      }
+      searchParameters: searchParameters
     });
 
     search.addWidget(
@@ -67,9 +81,15 @@
             } else {
               title = url;
             }
-            var link = '<a href="' + url + '">' + title +'</a>';
 
-            return '<div class="hit"><h2 class="hit-name">'+ link + '</h2><div class="hit-content">'+ item._highlightResult.text.value + '</div></div>';
+            //TODO: fix the baseurl on the entire site then remove this:
+            if ( baseUrl == '/' ) {
+              var link = '<a href="' + url + '">' + title +'</a>';
+            } else {
+              var link = '<a href="' + baseUrl + url + '">' + title +'</a>';
+            }
+
+            return '<div class="hit"><h2 class="hit-name">'+ link + '</h2><div class="hit-url">'+ document.location.origin + url +'</div><div class="hit-content">'+ item._highlightResult.text.value + '</div></div>';
           },
           empty: function ( query ) {
             return '<div id="no-results-message"><p>No results for the search <em>"' + query.query +'"</em>.</p></div>';
@@ -85,6 +105,20 @@
     );
 
 
+    search.addWidget(
+      instantsearch.widgets.refinementList({
+        container: '#tags',
+        attributeName: 'functional_areas',
+        operator: 'or',
+        limit: 20,
+        sortBy: ["name:asc"],
+        templates: {
+          header: 'Functional Areas'
+        }
+      })
+    );
+
+
 
 
     search.addWidget(
@@ -96,7 +130,6 @@
 
     search.start();
   }
-
 </script>
 
 

diff --git a/css/app.css b/css/app.css
diff --git a/guides/v2.0/bk-get-started-magento.md b/guides/v2.0/bk-get-started-magento.md
@@ -8,6 +8,8 @@ menu_node:
 version: 2.0
 github_link: bk-get-started-magento.md
 redirect_from: /guides/v1.0/bk-get-started-magento.html
+functional_areas:
+  - Integration
 ---
 
 <h2 id="highlights">Getting started with Magento</h2>

diff --git a/guides/v2.0/cloud/access-acct/fastly.md b/guides/v2.0/cloud/access-acct/fastly.md
@@ -8,6 +8,10 @@ menu_order: 5
 menu_node:
 version: 2.0
 github_link: cloud/access-acct/fastly.md
+functional_areas:
+  - Cloud
+  - Setup
+  - Configuration
 ---
 
 [Fastly]({{ page.baseurl}}cloud/basic-information/cloud-fastly.html) is required for {{site.data.var.ece}}, and is used in Staging and Production environments. It works with Varnish to provide fast caching capabilities and a {% glossarytooltip f83f1fa7-7a64-467b-b629-c2d0c25d2e7f %}Content Delivery Network{% endglossarytooltip %} (CDN) for static assets. Fastly is not available in Integration environments.
@@ -31,7 +35,7 @@ We'll provide you with the following credentials for your Staging and Production
 *	Fastly Service ID
 *	Fastly API token
 
-You can also locate these credentials in your Staging and Production systems in `/mnt/shared/fastly_tokens.txt`. You can SSH into the servers to verify the file in that location. If you do not locate this file, please enter a ticket for [Support]]({{ page.baseurl}}cloud/bk-cloud.html#gethelp) asking to have the file added. We can help provide this credentials file.
+You can also locate these credentials in your Staging and Production systems in `/mnt/shared/fastly_tokens.txt`. You can SSH into the servers to verify the file in that location. If you do not locate this file, please enter a ticket for [Support]({{ page.baseurl}}cloud/bk-cloud.html#gethelp) asking to have the file added. We can help provide this credentials file.
 
 <div class="bs-callout bs-callout-warning" markdown="1">
 Make note of which environment each set of credentials is used for. If you use the wrong credentials in an environment, you'll encounter issues with Fastly.

diff --git a/guides/v2.0/cloud/access-acct/first-time-deploy.md b/guides/v2.0/cloud/access-acct/first-time-deploy.md
@@ -7,6 +7,10 @@ menu_title: First time deployment
 menu_order: 60
 version: 2.0
 github_link: cloud/access-acct/first-time-deploy.md
+functional_areas:
+  - Cloud
+  - Setup
+  - Deploy
 ---
 
 #### Previous step:

diff --git a/guides/v2.0/cloud/access-acct/first-time-setup.md b/guides/v2.0/cloud/access-acct/first-time-setup.md
@@ -15,6 +15,9 @@ redirect_from:
   - /guides/v2.1/cloud/env/environment-tutorial-set-mage-vars.html
   - /guides/v2.0/cloud/access-acct/admin-env-vars.html
   - /guides/v2.1/cloud/access-acct/admin-env-vars.html
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 To create an account and start developing Magento, you need a configured local developer workspace, base {{site.data.var.ece}} code, and knowledge of the deployment workflow. These instructions guide through the entire process to create a development workspace on your local.

diff --git a/guides/v2.0/cloud/access-acct/first-time-setup_import-first-steps.md b/guides/v2.0/cloud/access-acct/first-time-setup_import-first-steps.md
@@ -10,6 +10,9 @@ level3_menu_node: level3child
 level3_subgroup: import
 version: 2.0
 github_link: cloud/access-acct/first-time-setup_import-first-steps.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 This topic discusses the workflow and initial tasks to perform before importing your existing Magento Enterprise Edition (EE) system into {{site.data.var.ece}} project.

diff --git a/guides/v2.0/cloud/access-acct/first-time-setup_import-import.md b/guides/v2.0/cloud/access-acct/first-time-setup_import-import.md
@@ -10,6 +10,9 @@ level3_menu_node: level3child
 level3_subgroup: import
 version: 2.0
 github_link: cloud/access-acct/first-time-setup_import-import.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 

diff --git a/guides/v2.0/cloud/access-acct/first-time-setup_import-parent.md b/guides/v2.0/cloud/access-acct/first-time-setup_import-parent.md
@@ -5,9 +5,12 @@ subgroup: 080_setup
 title: Import an existing Magento project
 menu_title: Import an existing Magento project
 menu_order: 150
-menu_node: 
+menu_node:
 level3_menu_node: level3parent
 level3_subgroup: import
 version: 2.0
 github_link: cloud/access-acct/first-time-setup_import-parent.md
+functional_areas:
+  - Cloud
+  - Setup
 ---