MAGEDOC-2744: Change devdocs baseurl definition

- updated links with the baseurl var - updated the config - updated the toc.yaml - tested locally
magento · Apr 16, 2018 · f5be866 · f5be866
1 parent d7fb414
commit f5be866
Show file tree

Hide file tree

Showing 1,911 changed files with 16,456 additions and 16,452 deletions.
diff --git a/_config.yml b/_config.yml
@@ -1,10 +1,11 @@
 # Site settings
 encoding: "utf-8"
 title: Magento 2 Developer Documentation
+logo: DevDocs
 email: mailto:DL-Magento-Doc-Feedback@magento.com
 description: > # this means to ignore newlines until "baseurl:"
   Magento 2 Developer Documentation.
-baseurl: "/"
+baseurl: ""
 # url: "https://github.com/magento/devdocs" # the base hostname & protocol for your site
 # twitter_username: magento
 # github_username:  magento
@@ -16,16 +17,16 @@ version: "2.2"
 versions:
    -
       name: "2.0"
-      url: guides/v2.0/
+      url: /guides/v2.0/
    -
       name: "2.1"
-      url: guides/v2.1/
+      url: /guides/v2.1/
    -
       name: "2.2"
-      url: guides/v2.2/
+      url: /guides/v2.2/
    -
       name: "2.3 Pre-release"
-      url: guides/v2.3/
+      url: /guides/v2.3/
 
 # GitHub variables
 github: "https://github.com/magento/devdocs/tree/develop/guides/"
@@ -100,4 +101,7 @@ algolia:
     - guides/m1x/**/*.md
     - swagger
 
+google:
+  analytics: 'UA-66243208-1'
+
 exclude: ['scss', 'bin', 'node_modules', 'vendor', '.git', '.idea', 'Rakefile' ]
diff --git a/_includes/cache/page-cache-checklists.md b/_includes/cache/page-cache-checklists.md
@@ -9,7 +9,7 @@
 
 -   Model and block level should identify themselves for invalidation support
 
--   Declare a custom [context variable]({{page.baseurl}}extension-dev-guide/cache/page-caching/public-content.html#configure-page-variations) if you plan to show different public content with the same URL
+-   Declare a custom [context variable]({{page.baseurl}}/extension-dev-guide/cache/page-caching/public-content.html#configure-page-variations) if you plan to show different public content with the same URL
 
 ## Non-cacheable page checklist
 -   Use POST requests to modify Magento state (e.g., adding to shopping cart, wishlist, etc.)

diff --git a/_includes/cache/page-cache-overview.md b/_includes/cache/page-cache-overview.md
@@ -9,11 +9,11 @@ Retrieving stored ({% glossarytooltip 0bc9c8bc-de1a-4a06-9c99-a89a29c30645 %}cac
 
 The Magento page cache library contains a simple PHP reverse proxy that enables full page caching out of the box. A reverse proxy acts as an intermediary between visitors and your application and can reduce the load on your server.
 
-We recommend using [Varnish]({{ page.baseurl }}config-guide/varnish/config-varnish.html), but you can use Magento's default caching mechanism instead, which stores cache files in any of the following:
+We recommend using [Varnish]({{ page.baseurl}}/config-guide/varnish/config-varnish.html), but you can use Magento's default caching mechanism instead, which stores cache files in any of the following:
 
 -   File system (You don't need to do anything to use file-based caching.)
--   [Database]({{ page.baseurl }}extension-dev-guide/cache/partial-caching/database-caching.html)
--   [Redis]({{ page.baseurl }}config-guide/redis/redis-pg-cache.html)
+-   [Database]({{ page.baseurl}}/extension-dev-guide/cache/partial-caching/database-caching.html)
+-   [Redis]({{ page.baseurl}}/config-guide/redis/redis-pg-cache.html)
 
 ## Cacheable and uncacheable pages {#cache-over-cacheable}
 *Cacheable* and *uncacheable* are terms we use to indicate whether or not a page should be cached at all. (By default, all pages are cacheable.) If any block in a {% glossarytooltip 73ab5daa-5857-4039-97df-11269b626134 %}layout{% endglossarytooltip %} is designated as uncacheable, the entire page is uncacheable.
@@ -31,6 +31,6 @@ Do not configure content pages (i.e., catalog, product, and CMS pages) to be unc
 ## Public and private content
 Reverse proxies serve "public" or shared content to more than one user. However, most Magento websites generate dynamic and personalized "private" content that should only be served to one user, which presents unique caching challenges. To address these challenges, Magento can distinguish between two types of content:
 
--   **[Public]({{page.baseurl}}extension-dev-guide/cache/page-caching/public-content.html)** - Public content is stored server side in your reverse proxy cache storage (e.g., file system, database, Redis, or Varnish) and is available to multiple customers. Examples of public content include header, footer, and category listing.
+-   **[Public]({{page.baseurl}}/extension-dev-guide/cache/page-caching/public-content.html)** - Public content is stored server side in your reverse proxy cache storage (e.g., file system, database, Redis, or Varnish) and is available to multiple customers. Examples of public content include header, footer, and category listing.
 
--   **[Private]({{page.baseurl}}extension-dev-guide/cache/page-caching/private-content.html)** - Private content is stored client side (e.g., browser) and is specific to an individual customer. Examples of private content include wishlist, shopping cart, customer name, and address. You should limit stored private content to a small portion of the page's total content.
+-   **[Private]({{page.baseurl}}/extension-dev-guide/cache/page-caching/private-content.html)** - Private content is stored client side (e.g., browser) and is specific to an individual customer. Examples of private content include wishlist, shopping cart, customer name, and address. You should limit stored private content to a small portion of the page's total content.
diff --git a/_includes/cloud/backup-db.md b/_includes/cloud/backup-db.md
@@ -14,7 +14,7 @@ Back up your Integration environment database and code:
 
 Back up your Staging or Production environment database before deploying to those environments:
 
-1.  [SSH to the server]({{ page.baseurl }}cloud/env/environments-ssh.html).
+1.  [SSH to the server]({{ page.baseurl}}/cloud/env/environments-ssh.html).
 
 2.  Enter the following command to create a database dump:
 

diff --git a/_includes/cloud/cli-get-started.md b/_includes/cloud/cli-get-started.md
@@ -1,6 +1,6 @@
 <div markdown="1">
 
-1.	Log in to your local development system, or switch to, the [Magento file system owner]({{ page.baseurl }}cloud/before/before-workspace-file-sys-owner.html).
+1.	Log in to your local development system, or switch to, the [Magento file system owner]({{ page.baseurl}}/cloud/before/before-workspace-file-sys-owner.html).
 2.	Change to a directory to which the Magento file system owner has write access.
 2.	Enter the following command in a terminal to log in to your project:
 
@@ -32,6 +32,6 @@
 8.	Pull any updated code to your local for the environment ID (which is the Git branch):
 
 		git pull origin <environment ID>
-7.  Create a [snapshot]({{page.baseurl}}cloud/project/project-webint-snap.html) of the environment as a backup:
+7.  Create a [snapshot]({{page.baseurl}}/cloud/project/project-webint-snap.html) of the environment as a backup:
 
         magento-cloud snapshot:create -e <environment ID>
diff --git a/_includes/cloud/composer-name.md b/_includes/cloud/composer-name.md
@@ -7,13 +7,13 @@ To get the module's Composer name from Magento Marketplace:
 1.	Log in to [Magento Marketplace](https://marketplace.magento.com){:target="_blank"} with the user name and password you used to purchase the component.
 2.	In the upper right corner, click **&lt;your user name>** > **My Account** as the following figure shows.
 
-	![Access your Marketplace account]({{ site.baseurl }}common/images/cloud_marketplace-account.png){:width="650px"}
+	![Access your Marketplace account]({{ site.baseurl}}/common/images/cloud_marketplace-account.png){:width="650px"}
 3.	On the My Account page, click **My Purchases** as the following figure shows.
 
-	![Marketplace purchase history]({{ site.baseurl }}common/images/cloud_marketplace-purch-history.png){:width="650px"}
+	![Marketplace purchase history]({{ site.baseurl}}/common/images/cloud_marketplace-purch-history.png){:width="650px"}
 4.	On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows.
 
-	![Technical details shows the module's Composer name]({{ site.baseurl }}common/images/cloud_marketplace-download-invoice.png){:width="200px"}
+	![Technical details shows the module's Composer name]({{ site.baseurl}}/common/images/cloud_marketplace-download-invoice.png){:width="200px"}
 5.	Click **Copy** to copy the component name to the clipboard.
 5.	Open a text editor.
 6.	Paste the module name in the text editor.

diff --git a/_includes/cloud/cron-consumers-runner.md b/_includes/cloud/cron-consumers-runner.md
@@ -15,4 +15,4 @@ You must set the variable value using JSON. For example:
 
 -   `cron_run`—A boolean value that enables or disables the `consumers_runner` cron job (default = `false`).
 -   `max_messages`—A number specifying the maximum number of messages each consumer must process before terminating (default = `1000`). Although we do not recommend it, you can use `0` to prevent the consumer from terminating.
--   `consumers`—An array of strings specifying which consumer(s) to run. An empty array runs _all_ consumers. Refer to [List consumers]({{page.baseurl}}config-guide/mq/manage-mysql.html#list-consumers) for more information.
+-   `consumers`—An array of strings specifying which consumer(s) to run. An empty array runs _all_ consumers. Refer to [List consumers]({{page.baseurl}}/config-guide/mq/manage-mysql.html#list-consumers) for more information.
diff --git a/_includes/cloud/data-collection.md b/_includes/cloud/data-collection.md
@@ -1,8 +1,8 @@
 <div markdown="1">
 
-To help export Production data as test data to use in Staging and Integration environments, [Run the support utilities]({{ page.baseurl }}config-guide/cli/config-cli-subcommands-spt-util.html):
+To help export Production data as test data to use in Staging and Integration environments, [Run the support utilities]({{ page.baseurl}}/config-guide/cli/config-cli-subcommands-spt-util.html):
 
-* [CLI commands]({{ page.baseurl }}config-guide/cli/config-cli-subcommands-spt-util.html#config-cli-spt-utils-db) (Recommended) to export a protected backup of customer and store data using your Magento encryption key
+* [CLI commands]({{ page.baseurl}}/config-guide/cli/config-cli-subcommands-spt-util.html#config-cli-spt-utils-db) (Recommended) to export a protected backup of customer and store data using your Magento encryption key
 * [Data Collection](http://docs.magento.com/m2/ee/user_guide/system/support-data-collector.html){:target="_blank"} tool for generating and exporting data
 
-To migrate this data, see [Migrate and deploy static files and data]({{ page.baseurl }}cloud/live/stage-prod-migrate.html).
+To migrate this data, see [Migrate and deploy static files and data]({{ page.baseurl}}/cloud/live/stage-prod-migrate.html).
diff --git a/_includes/cloud/enable-ssh.md b/_includes/cloud/enable-ssh.md
@@ -4,7 +4,7 @@ You must create an SSH key pair on every machine and workspace you and your team
 
 The SSH keys require the following:
 
-* Set up SSH keys as the [Magento file system owner]({{ page.baseurl }}cloud/before/before-workspace-file-sys-owner.html).
+* Set up SSH keys as the [Magento file system owner]({{ page.baseurl}}/cloud/before/before-workspace-file-sys-owner.html).
 * Create the keys using the email address used for the GitHub account.
 
 For more information on SSH keys, see the following:
@@ -99,7 +99,7 @@ You can add SSH keys to your account in any of the following ways:
 To add an SSH key using the CLI:
 
 1.	Open a terminal application on your local.
-2.	If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
+2.	If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl}}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
 
 3.	Log in to your project:
 
@@ -123,10 +123,10 @@ To add an SSH key using the Project Web Interface:
 2.	Login and access your project through the [Project Web Interface](https://accounts.magento.cloud){:target="_blank"}.
 3.	In your selected branch, an icon displays if you do not have an SSH key added.
 
-	![No SSH key]({{ site.baseurl }}common/images/cloud_ssh-key-install.png)
+	![No SSH key]({{ site.baseurl}}/common/images/cloud_ssh-key-install.png)
 4.	Copy and paste the content of your public SSH key in the screen.
 
-	![Add SSH key]({{ site.baseurl }}common/images/cloud_ssh-key-add.png)
+	![Add SSH key]({{ site.baseurl}}/common/images/cloud_ssh-key-add.png)
 5.	Follow the prompts on your screen to complete the task.
 
 ## Set global Git variables

diff --git a/_includes/cloud/hooks.md b/_includes/cloud/hooks.md
@@ -1,6 +1,6 @@
 <div markdown="1">
 
-For technical reasons, you must enter a Support ticket to add your [`.magento.app.yaml`]({{page.baseurl}}cloud/project/project-conf-files_magento-app.html) file to Staging and Production environments. This affects all Pro projects created before and after October 23, 2017.
+For technical reasons, you must enter a Support ticket to add your [`.magento.app.yaml`]({{page.baseurl}}/cloud/project/project-conf-files_magento-app.html) file to Staging and Production environments. This affects all Pro projects created before and after October 23, 2017.
 
 You can request that we push `.magento.app.yaml`, `services.yaml`, and `routes.yaml`, set up cron jobs, and enable Xdebug and PHPUnit, which assists you in troubleshooting coding issues encountered during deployment. Because of the memory requirements, we recommend you disable Xdebug before your site is live.
 

diff --git a/_includes/cloud/new-project-from-template.md b/_includes/cloud/new-project-from-template.md
@@ -3,24 +3,24 @@
 1. Access your account. You can open the email you received from Magento Cloud (accounts@magento.cloud) and click the _Access your project now_ link. Or you can log in to [your Magento Commerce account](https://accounts.magento.cloud){:target="_blank"}.
 2. Click the _This project has no code yet_ link next to the Project name.
 
-	![Project without code]({{site.baseurl}}common/images/cloud_project_empty.png)
+	![Project without code]({{site.baseurl}}/common/images/cloud_project_empty.png)
 
 3. Enter a name for the project.
 
-	![Project name]({{site.baseurl}}common/images/cloud_project_name.png)
+	![Project name]({{site.baseurl}}/common/images/cloud_project_name.png)
 
 4. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
 
-	![Create a site using the sample Magento project]({{site.baseurl}}common/images/cloud_project_template.png){:width="650px"}
+	![Create a site using the sample Magento project]({{site.baseurl}}/common/images/cloud_project_template.png){:width="650px"}
 
-5. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{page.baseurl}}install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
+5. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{page.baseurl}}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
 
-	![Enter your authentication keys]({{site.baseurl}}common/images/cloud-project-magento-auth-creds.png){:width="650px"}
+	![Enter your authentication keys]({{site.baseurl}}/common/images/cloud-project-magento-auth-creds.png){:width="650px"}
 
 	The keys are added to the `auth.json` file in the repository `master` branch, required for all created branches and deployments.
 
 6. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
 
-	![Your sample Magento project]({{site.baseurl}}common/images/cloud_project_template2.png){:width="650px"}
+	![Your sample Magento project]({{site.baseurl}}/common/images/cloud_project_template2.png){:width="650px"}
 
 7. After the project deploys, **Success** displays next to the name of your project.
diff --git a/_includes/cloud/note-pro-legacy.md b/_includes/cloud/note-pro-legacy.md
@@ -1,3 +1,3 @@
 <div class="bs-callout bs-callout-warning" markdown="1">
-For Pro projects **created before October 23, 2017**, the architecture is slightly different. See [Pro architecture (legacy)]({{page.baseurl}}cloud/architecture/pro-architecture-legacy.html).
+For Pro projects **created before October 23, 2017**, the architecture is slightly different. See [Pro architecture (legacy)]({{page.baseurl}}/cloud/architecture/pro-architecture-legacy.html).
 </div>
diff --git a/_includes/cloud/note-pro-using-yaml.md b/_includes/cloud/note-pro-using-yaml.md
@@ -1,3 +1,3 @@
 <div class="bs-callout bs-callout-info" id="info">
-  <p>For Pro projects **created before October 23, 2017**, the changes you make using this YAML file affects your Integration environment only. To make these changes in a Staging or Production environment, you must <a href="{{page.baseurl}}cloud/trouble/pro-env-management.html">Add Staging and Production to Pro projects UI</a>.</p>
+  <p>For Pro projects **created before October 23, 2017**, the changes you make using this YAML file affects your Integration environment only. To make these changes in a Staging or Production environment, you must <a href="{{page.baseurl}}/cloud/trouble/pro-env-management.html">Add Staging and Production to Pro projects UI</a>.</p>
 </div>