Merge pull request magento#1328 from magento/jc_add-algolia-tags

Add Algolia tags to docset
mrodespin · Oct 27, 2017 · add4f9a · add4f9a
2 parents c9a2c5c + ad96894
commit add4f9a
Show file tree

Hide file tree

Showing 803 changed files with 3,270 additions and 686 deletions.
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/common/js/app.min.js b/common/js/app.min.js
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.

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
 ---
diff --git a/guides/v2.0/cloud/access-acct/first-time-setup_import-prepare.md b/guides/v2.0/cloud/access-acct/first-time-setup_import-prepare.md
@@ -10,6 +10,9 @@ level3_menu_node: level3child
 level3_subgroup: import
 version: 2.0
 github_link: cloud/access-acct/first-time-setup_import-prepare.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 This topic discusses tasks you must perform in your existing Magento EE installation to prepare it to be imported into a {{site.data.var.ece}} project.

diff --git a/guides/v2.0/cloud/access-acct/first-time-setup_import-prereq.md b/guides/v2.0/cloud/access-acct/first-time-setup_import-prereq.md
@@ -10,6 +10,9 @@ level3_menu_node: level3child
 level3_subgroup: import
 version: 2.0
 github_link: cloud/access-acct/first-time-setup_import-prereq.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 This topic discusses how to find the information necessary to import Magento EE into {{site.data.var.ece}}.

diff --git a/guides/v2.0/cloud/access-acct/trouble.md b/guides/v2.0/cloud/access-acct/trouble.md
@@ -8,6 +8,9 @@ menu_order: 3
 menu_node:
 version: 2.0
 github_link: cloud/access-acct/trouble.md
+functional_areas:
+  - Cloud
+  - Deploy
 ---
 
 This topic discusses how to recover if you deployed the Magento application with the incorrect [Magento authentication keys]({{page.baseurl}}install-gde/prereq/connect-auth.html). For example, you might have used the keys for another account or you might have used Magento Community Edition (CE) keys instead of Magento Enterprise Edition (EE) keys.

diff --git a/guides/v2.0/cloud/basic-information/cloud-fastly.md b/guides/v2.0/cloud/basic-information/cloud-fastly.md
@@ -8,6 +8,9 @@ menu_node:
 menu_order: 15
 version: 2.0
 github_link: cloud/welcome/cloud-fastly.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 Fastly is a CDN based on Varnish caching, basically a cloud varnish service. When working with Fastly, you are also working directly with a heavily customized version of Varnish (2.1). [Fastly](https://docs.fastly.com/){:target="_blank"} with [Varnish](https://varnish-cache.org/docs/){:target="_blank"} caches your site pages, assets, CSS, and more in backend datacenters you set up. As customers access your site and stores, the requests hit Fastly to load cached pages faster.

diff --git a/guides/v2.0/cloud/basic-information/starter-architecture.md b/guides/v2.0/cloud/basic-information/starter-architecture.md
@@ -8,6 +8,8 @@ menu_order: 20
 menu_node:
 version: 2.0
 github_link: cloud/basic-information/starter-architecture.md
+functional_areas:
+  - Cloud
 ---
 
 All of your code is contained in the {{site.data.var.ece}} Starter project. The _project_ is your Magento store code, extensions, and integrations in a Master Git branch. Each project supports up to 4 total environments including three active Integration *environments* and a Production environment using the `master` Git branch.

diff --git a/guides/v2.0/cloud/basic-information/starter-develop-deploy-workflow.md b/guides/v2.0/cloud/basic-information/starter-develop-deploy-workflow.md
@@ -8,6 +8,8 @@ menu_order: 25
 menu_node:
 version: 2.0
 github_link: cloud/basic-information/starter-develop-deploy-workflow.md
+functional_areas:
+  - Cloud
 ---
 
 Everything in {{site.data.var.ece}} is Git-driven. Your [project]({{ page.baseurl }}cloud/project/projects.html) is a Master Git branch cloned from a Magento 2 repository. Every active Git branch has an associated full environment. Depending on your {{site.data.var.ece}} plan subscription, your deployment workflow may differ.

diff --git a/guides/v2.0/cloud/before/before-project-owner.md b/guides/v2.0/cloud/before/before-project-owner.md
@@ -8,6 +8,10 @@ menu_order: 10
 menu_node:
 version: 2.0
 github_link: cloud/before/before-project-owner.md
+functional_areas:
+  - Cloud
+  - Setup
+  - Configuration
 ---
 
 To initially set up your {{site.data.var.ece}} project, you need the Project Owner to create the project, add a super user, and generate {{site.data.var.ee}} authentication keys. The account owner has sole authority over the project and account to manage your store, project and Git access, and more.

diff --git a/guides/v2.0/cloud/before/before-setup-env-2_clone.md b/guides/v2.0/cloud/before/before-setup-env-2_clone.md
@@ -15,6 +15,9 @@ redirect_from:
   - /guides/v2.0/cloud/before/before-setup-env-env.html
   - /guides/v2.1/cloud/before/before-setup-env-env.html
   - /guides/v2.2/cloud/before/before-setup-env-env.html
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 #### Previous step:

diff --git a/guides/v2.0/cloud/before/before-setup-env-install.md b/guides/v2.0/cloud/before/before-setup-env-install.md
@@ -11,6 +11,11 @@ redirect_from:
   - /guides/v2.0/cloud/before/before-setup-env-perms.html
   - /guides/v2.1/cloud/before/before-setup-env-perms.html
   - /guides/v2.2/cloud/before/before-setup-env-perms.html
+functional_areas:
+  - Cloud
+  - Install
+  - Setup
+  - Configuration
 ---
 
 #### Previous step:

diff --git a/guides/v2.0/cloud/before/before-workspace-file-sys-owner.md b/guides/v2.0/cloud/before/before-workspace-file-sys-owner.md
@@ -8,6 +8,9 @@ menu_order: 25
 menu_node:
 version: 2.0
 github_link: cloud/before/before-workspace-file-sys-owner.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 #### Previous step: {#mage-owner-about-group}
 [Enable SSH keys]({{ page.baseurl }}cloud/before/before-workspace-ssh.html)

diff --git a/guides/v2.0/cloud/before/before-workspace-magento-prereqs.md b/guides/v2.0/cloud/before/before-workspace-magento-prereqs.md
@@ -15,6 +15,10 @@ redirect_from:
   - /guides/v2.0/cloud/before/before-workspace-cli.html
   - /guides/v2.1/cloud/before/before-workspace-cli.html
   - /guides/v2.2/cloud/before/before-workspace-cli.html
+functional_areas:
+  - Cloud
+  - Setup
+  - Configuration
 ---
 
 #### Previous step:

diff --git a/guides/v2.0/cloud/before/before-workspace-ssh.md b/guides/v2.0/cloud/before/before-workspace-ssh.md
@@ -12,6 +12,9 @@ redirect_from:
   - /guides/v2.0/cloud/before/before-setup-env-1_get-start.html
   - /guides/v2.1/cloud/before/before-setup-env-1_get-start.html
   - /guides/v2.2/cloud/before/before-setup-env-1_get-start.html
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 #### Previous step:

diff --git a/guides/v2.0/cloud/before/before-workspace.md b/guides/v2.0/cloud/before/before-workspace.md
@@ -9,12 +9,15 @@ menu_node:
 version: 2.0
 github_link: cloud/before/before-workspace.md
 redirect_from:
-  -  /guides/v2.0/cloud/access-acct/set-up-env.html
-  -  /guides/v2.1/cloud/access-acct/set-up-env.html
-  -  /guides/v2.1/cloud/access-acct/set-up-env.html
+  - /guides/v2.0/cloud/access-acct/set-up-env.html
+  - /guides/v2.1/cloud/access-acct/set-up-env.html
+  - /guides/v2.1/cloud/access-acct/set-up-env.html
   - /guides/v2.0/cloud/access-acct/first-time-setup_template.html
   - /guides/v2.1/cloud/access-acct/first-time-setup_template.html
   - /guides/v2.2/cloud/access-acct/first-time-setup_template.html
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 To develop, deploy, and test {{site.data.var.ece}}, you need to setup your local environment and clone your project's master Git branch. This local environment provides a development system for your custom code, extensions, and configurations to push for active testing in one of of the Integration environments.

diff --git a/guides/v2.0/cloud/bk-cloud.md b/guides/v2.0/cloud/bk-cloud.md
@@ -19,6 +19,8 @@ redirect_from:
   - /guides/v2.0/cloud/welcome/10000-ft-overview.html
   - /guides/v2.1/cloud/welcome/10000-ft-overview.html
   - /guides/v2.2/cloud/welcome/10000-ft-overview.html
+functional_areas:
+  - Cloud
 ---
 
 {{site.data.var.ece}}, formerly Enterprise Cloud Edition, is a managed and automated hosting platform for Magento specifically created for Cloud infrastructures. This version combines {{site.data.var.ee}}, Cloud infrastructure hosting, with a few differences and added features including Git integration and key environments for development, staging, and live production.

diff --git a/guides/v2.0/cloud/configure/cloud-vcl-custom-snippets.md b/guides/v2.0/cloud/configure/cloud-vcl-custom-snippets.md
@@ -8,6 +8,9 @@ menu_order: 7
 menu_node:
 version: 2.0
 github_link: cloud/configure/cloud-vcl-custom-snippets.md
+functional_areas:
+  - Cloud
+  - Setup
 ---
 
 [Fastly]({{ page.baseurl}}cloud/basic-information/cloud-fastly.html) and {{site.data.var.ece}} support creating custom Varnish Configuration Language (VCL) snippets. For best results, we recommend creating Edge Dictionaries and Edge ACLs for your VCL snippets. You're free to customize your Fastly VCL snippets any way you like to complete custom code. The following examples and instructions walk through creating edge dictionaries, edge ACLs, and VCL snippets.

diff --git a/guides/v2.0/cloud/configure/configuration-overview.md b/guides/v2.0/cloud/configure/configuration-overview.md
@@ -8,6 +8,9 @@ menu_order: 1
 menu_node: parent
 version: 2.0
 github_link: cloud/configure/configuration-overview.md
+functional_areas:
+  - Cloud
+  - Configuration
 ---
 
 The following information walks you through the options for configuring your store on your local and in all environments. You may need to configure files and settings in your local, pushing settings with your code. For specific services, you configure settings directly in Staging and Production environments.

diff --git a/guides/v2.0/cloud/configure/setup-cron-jobs.md b/guides/v2.0/cloud/configure/setup-cron-jobs.md
@@ -8,6 +8,10 @@ menu_order: 17
 menu_node:
 version: 2.0
 github_link: cloud/configure/setup-cron-jobs.md
+functional_areas:
+  - Cloud
+  - Setup
+  - Configuration
 ---
 
 Magento uses cron jobs for numerous features to schedule activities. You can add cron jobs to `.magento.app.yaml` and push it to your branches for deployment. For specific information for configuring and setting up cron in Magento, see [Magento Commerce cron information](#croninfo). The following information is specific to creating and deploying cron jobs in {{site.data.var.ece}}.

diff --git a/guides/v2.0/cloud/deploy/continuous-deployment.md b/guides/v2.0/cloud/deploy/continuous-deployment.md
@@ -8,6 +8,9 @@ menu_order: 15
 menu_node:
 version: 2.0
 github_link: cloud/deploy/continuous-deployment.md
+functional_areas:
+  - Cloud
+  - Deploy
 ---
 
 Following your branching and development methodologies, you can easily develop new features, configure changes, and add extensions to continuously develop and deploy updates.

diff --git a/guides/v2.0/cloud/env/environment-vars-parent.md b/guides/v2.0/cloud/env/environment-vars-parent.md
@@ -1,11 +1,14 @@
 ---
 layout: default
 group:
-subgroup: 
+subgroup:
 title: Environment variables
 menu_title: Environment variables
 menu_order:
 menu_node:
 version: 2.0
 github_link: cloud/env/environment-vars-parent.md
+functional_areas:
+  - Cloud
+  - Configuration
 ---