From 38180efe598c01caf4042482cda51a69b8dec603 Mon Sep 17 00:00:00 2001 From: Alex Taranovsky Date: Wed, 11 Sep 2019 17:23:04 +0300 Subject: [PATCH] magento/devdocs#5245: Markdown linting: Hard tabs (MD010) #5245 --- _includes/browsers/supported-browsers.md | 14 +- _includes/cloud/cli-get-started.md | 38 +- .../cloud-fastly-manage-vcl-from-admin.md | 6 +- _includes/cloud/composer-name.md | 30 +- _includes/cloud/enable-ssh.md | 48 +- _includes/cloud/new-project-from-template.md | 12 +- _includes/cloud/patch.md | 116 +-- _includes/cloud/ssh-tunnel.md | 30 +- _includes/comp-man/backup.md | 18 +- _includes/comp-man/checklist.md | 20 +- _includes/comp-man/checklist_2.2.md | 8 +- _includes/comp-man/readiness-check.md | 16 +- _includes/config/cron-overview.md | 16 +- _includes/config/es-verify-proxy.md | 4 +- _includes/config/es-webserver-overview.md | 26 +- _includes/config/install-java.md | 10 +- _includes/config/install-java8.md | 10 +- _includes/config/multi-site_verify.md | 6 +- _includes/config/php-memcache.md | 12 +- _includes/config/redis-verify.md | 4 +- _includes/config/secure-ws-apache_step1.md | 36 +- _includes/config/secure-ws-apache_step2.md | 6 +- _includes/config/setup-cron.md | 26 +- _includes/config/setup-cron_2.2.md | 22 +- _includes/config/setup-cron_2.2_about.md | 8 +- _includes/config/setup-cron_2.2_how-to.md | 24 +- _includes/config/solr-elastic-selinux.md | 8 +- _includes/config/split-db.md | 48 +- .../config/split-deploy/config-mgmt-over1.md | 12 +- .../config/split-deploy/example_build-sync.md | 24 +- .../split-deploy/example_update-prod.md | 30 +- .../split-deploy/split-deploy-assumptions.md | 10 +- _includes/full-width/404-page-header.html | 2 +- _includes/home/videos.html | 2 +- _includes/install/allowoverrides22.md | 44 +- _includes/install/allowoverrides24.md | 2 +- _includes/install/auth-tokens-get.md | 18 +- _includes/install/composer-clone.md | 8 +- _includes/install/file-system-perms-before.md | 6 +- .../file-system-perms-twouser_cmds-only.md | 4 +- .../file-system-perms-twouser_cmds-only_22.md | 4 +- _includes/install/file-system-umask-over.md | 26 +- _includes/install/flow-diagram.md | 30 +- _includes/install/fully-secure.md | 8 +- _includes/install/get-software_zip.md | 48 +- _includes/install/install-roadmap.md | 26 +- .../mysql_max-allowed-packet-centos.md | 10 +- .../mysql_max-allowed-packet-ubuntu.md | 6 +- _includes/install/patch/get-patch.md | 60 +- _includes/install/paypal-tls1-2.md | 38 +- .../releasenotes/20_release-notes-links.md | 86 +- .../releasenotes/20rc_release-notes-links.md | 12 +- .../releasenotes/21_release-notes-links.md | 74 +- .../install/releasenotes/ce_install_20.md | 22 +- .../install/releasenotes/ee_install_20.md | 22 +- .../releasenotes/get-ce-software_zip.md | 14 +- .../releasenotes/get-ee-software_zip.md | 20 +- .../sampledata/sample-data-other-cmds.md | 10 +- .../install/sampledata/sample-data-rc1-cli.md | 38 +- .../install/sampledata/sample-data-rc1-web.md | 24 +- .../sampledata/sample-data_list-of-modules.md | 54 +- _includes/install/sens-data.md | 14 +- _includes/install/tls-repo.md | 6 +- _includes/install/trouble/rc_cron.md | 46 +- _includes/install/trouble/rc_php-version.md | 16 +- _includes/install/ulimit.md | 12 +- _includes/install/web/install-web.md | 20 +- .../install/web/install-web_1-readiness.md | 8 +- _includes/install/web/install-web_2-db.md | 66 +- .../install/web/install-web_3-web-conf.md | 6 +- .../web/install-web_4-customize-store.md | 32 +- .../install/web/install-web_5-create-admin.md | 4 +- .../install/web/install-web_6-install.md | 20 +- _includes/layout/page-header.html | 14 +- _includes/layout/sidebar.html | 24 +- _includes/layout/version-switcher.html | 16 +- _includes/m1x/eol_message.html | 2 +- _includes/php-dev/component-root-2.3.md | 6 +- _includes/php-dev/component-root.md | 8 +- _includes/php-dev/component-versioning.md | 6 +- codelinks/attributes.md | 50 +- guides/v2.2/architecture/tech-stack.md | 38 +- guides/v2.2/b2b/company-object.md | 4 +- guides/v2.2/b2b/company-structures.md | 2 +- guides/v2.2/b2b/company-users.md | 26 +- guides/v2.2/b2b/negotiable-checkout.md | 8 +- guides/v2.2/b2b/negotiable-manage.md | 6 +- guides/v2.2/b2b/negotiable-order-workflow.md | 4 +- guides/v2.2/b2b/shared-cat-product-assign.md | 46 +- .../basic-information/starter-architecture.md | 18 +- .../cloud/before/before-setup-env-2_clone.md | 4 +- .../before/before-workspace-file-sys-owner.md | 28 +- .../before-workspace-magento-prereqs.md | 86 +- .../cloud/cdn/cloud-fastly-custom-response.md | 12 +- guides/v2.2/cloud/cdn/configure-fastly.md | 4 +- .../cloud/cdn/fastly-image-optimization.md | 10 +- .../v2.2/cloud/cdn/fastly-vcl-badreferer.md | 4 +- guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md | 8 +- guides/v2.2/cloud/cdn/fastly-vcl-wordpress.md | 20 +- guides/v2.2/cloud/cdn/trouble-fastly.md | 70 +- .../cloud/configure/import-url-rewrites.md | 4 +- guides/v2.2/cloud/env/environments-ssh.md | 34 +- guides/v2.2/cloud/env/set-variables.md | 2 +- guides/v2.2/cloud/howtos/custom-theme.md | 18 +- guides/v2.2/cloud/howtos/debug.md | 144 ++-- .../howtos/environment-tutorial-env-merge.md | 66 +- guides/v2.2/cloud/howtos/how-to.md | 12 +- guides/v2.2/cloud/howtos/sample-data.md | 14 +- guides/v2.2/cloud/live/go-live-checklist.md | 28 +- guides/v2.2/cloud/live/live-prot.md | 8 +- guides/v2.2/cloud/live/live-sanity-check.md | 72 +- guides/v2.2/cloud/live/sens-data-initial.md | 134 +-- guides/v2.2/cloud/live/stage-prod-live.md | 8 +- .../cloud/onboarding/onboarding-portal.md | 2 +- guides/v2.2/cloud/project/project-start.md | 10 +- .../cloud/project/project-webint-basic.md | 34 +- .../v2.2/cloud/project/project-webint-snap.md | 28 +- guides/v2.2/cloud/reference/cloud-composer.md | 18 +- .../v2.2/cloud/reference/git-integration.md | 6 +- .../cloud/requirements/cloud-requirements.md | 76 +- guides/v2.2/cloud/setup/first-time-deploy.md | 48 +- .../first-time-setup-import-first-steps.md | 12 +- .../v2.2/cloud/trouble/environments-logs.md | 10 +- .../trouble/restore-configuration-files.md | 6 +- guides/v2.2/cloud/trouble/trouble_ce-creds.md | 52 +- .../cloud/trouble/trouble_comp-deploy-fail.md | 10 +- .../cloud/trouble/troubleshoot-deployment.md | 2 +- .../code-standard-demarcation.md | 8 +- .../docblock-standard-javascript.md | 784 +++++++++--------- .../v2.2/comp-mgr/bk-compman-upgrade-guide.md | 18 +- guides/v2.2/comp-mgr/cli/cli-upgrade.md | 4 +- .../comp-mgr/extens-man/extensman-backup.md | 6 +- .../extens-man/extensman-checklist.md | 6 +- .../comp-mgr/extens-man/extensman-main-pg.md | 208 ++--- .../extens-man/extensman-readiness-fail.md | 12 +- .../extens-man/extensman-readiness-multi.md | 24 +- .../extens-man/extensman-readiness.md | 6 +- .../extens-man/extensman-uninst-data.md | 8 +- .../v2.2/comp-mgr/marketplace/marketplace.md | 8 +- .../v2.2/comp-mgr/module-man/compman-start.md | 18 +- .../prereq/prereq_compman-checklist.md | 8 +- guides/v2.2/comp-mgr/prereq/prereq_compman.md | 12 +- .../comp-mgr/trouble/cman/ce-ee-upgrade.md | 14 +- guides/v2.2/comp-mgr/trouble/cman/cron.md | 22 +- guides/v2.2/comp-mgr/trouble/cman/doc.md | 26 +- .../v2.2/comp-mgr/trouble/cman/gitignore.md | 12 +- .../v2.2/comp-mgr/trouble/cman/maint-mode.md | 116 +-- .../comp-mgr/trouble/cman/out-of-memory.md | 18 +- .../comp-mgr/trouble/cman/tshoot_backup.md | 18 +- .../v2.2/comp-mgr/trouble/cman/update-fail.md | 10 +- .../comp-mgr/trouble/cman/upgrade_51431.md | 72 +- .../v2.2/comp-mgr/trouble/cman/were-sorry.md | 48 +- guides/v2.2/comp-mgr/trouble/tshoot.md | 16 +- .../v2.2/comp-mgr/updater/update-updater.md | 10 +- .../comp-mgr/upgrader/ce-ee-upgrade-start.md | 24 +- .../comp-mgr/upgrader/upgrade-checklist.md | 8 +- .../v2.2/comp-mgr/upgrader/upgrade-main-pg.md | 108 +-- .../v2.2/comp-mgr/upgrader/upgrade-start.md | 38 +- guides/v2.2/comp-mgr/upgrader/upgrade.md | 20 +- guides/v2.2/config-guide/bk-config-guide.md | 44 +- .../v2.2/config-guide/bootstrap/mage-dirs.md | 42 +- .../config-guide/bootstrap/mage-profiler.md | 10 +- .../bootstrap/magento-bootstrap.md | 74 +- .../bootstrap/magento-how-to-set.md | 88 +- .../config-guide/bootstrap/magento-modes.md | 84 +- .../cli/config-cli-subcommands-cache.md | 50 +- .../cli/config-cli-subcommands-depen.md | 98 +-- .../cli/config-cli-subcommands-layout-xml.md | 2 +- .../cli/config-cli-subcommands-less-sass.md | 74 +- .../cli/config-cli-subcommands-mode.md | 64 +- .../cli/config-cli-subcommands-perf-data.md | 28 +- .../cli/config-cli-subcommands-spt-util.md | 24 +- ...li-subcommands-static-deploy-strategies.md | 4 +- .../cli/config-cli-subcommands-static-view.md | 8 +- .../cli/config-cli-subcommands-test.md | 6 +- guides/v2.2/config-guide/cron/custom-cron.md | 14 +- .../config-guide/db-profiler/db-profiler.md | 6 +- guides/v2.2/config-guide/deployment/index.md | 36 +- .../deployment/pipeline/build-system.md | 80 +- .../deployment/pipeline/development-system.md | 20 +- .../pipeline/example/environment-variables.md | 134 +-- .../pipeline/example/shared-configuration.md | 46 +- .../config-guide/deployment/pipeline/index.md | 16 +- .../deployment/pipeline/production-system.md | 76 +- .../deployment/pipeline/technical-details.md | 22 +- .../elasticsearch/es-config-apache.md | 150 ++-- .../elasticsearch/es-config-nginx.md | 172 ++-- .../elasticsearch/es-config-stopwords.md | 14 +- guides/v2.2/config-guide/log/log-intro.md | 4 +- guides/v2.2/config-guide/log/log-magento.md | 10 +- .../v2.2/config-guide/mq/rabbitmq-overview.md | 6 +- .../config-guide/multi-master/multi-master.md | 36 +- .../multi-master/multi-master_masterdb.md | 6 +- .../multi-master/multi-master_slavedb.md | 12 +- .../multi-master/multi-master_verify.md | 20 +- .../v2.2/config-guide/multi-site/ms_nginx.md | 68 +- .../config-guide/multi-site/ms_websites.md | 118 +-- .../config-guide/prod/config-reference-b2b.md | 4 +- .../prod/config-reference-gitignore.md | 12 +- .../prod/config-reference-most.md | 4 +- .../prod/config-reference-payment.md | 4 +- .../prod/config-reference-sens.md | 10 +- .../prod/config-reference-var-name.md | 150 ++-- .../config-guide/prod/prod_file-sys-perms.md | 114 +-- guides/v2.2/config-guide/secy/secy-cron.md | 126 +-- guides/v2.2/config-guide/secy/secy-headers.md | 20 +- guides/v2.2/config-guide/secy/secy-xframe.md | 18 +- guides/v2.2/config-guide/secy/secy.md | 4 +- .../varnish/config-varnish-configure.md | 168 ++-- .../varnish/config-varnish-final.md | 48 +- .../varnish/config-varnish-install.md | 14 +- .../varnish/config-varnish-magento.md | 104 +-- .../config-guide/varnish/config-varnish.md | 74 +- .../varnish/tshoot-varnish-503.md | 38 +- .../varnish/use-multiple-varnish-cache.md | 2 +- .../varnish/use-varnish-cache-how.md | 6 +- .../config-guide/varnish/use-varnish-cache.md | 22 +- .../iconography/iconography.md | 12 +- .../design-styleguide/pagegrid/pagegrid.md | 12 +- guides/v2.2/extension-dev-guide/attributes.md | 2 +- .../bk-extension-dev-guide.md | 6 +- .../v2.2/extension-dev-guide/build/build.md | 16 +- .../build/composer-integration.md | 4 +- .../extension-dev-guide/build/di-xml-file.md | 10 +- .../build/module-file-structure.md | 20 +- .../build/module-load-order.md | 2 +- .../build/required-configuration-files.md | 24 +- .../cache/partial-caching.md | 38 +- .../partial-caching/create-cache-type.md | 6 +- .../cache/partial-caching/database-caching.md | 144 ++-- .../extension-dev-guide/cli-cmds/cli-add.md | 6 +- .../extension-dev-guide/cli-cmds/cli-howto.md | 24 +- .../cli-cmds/cli-naming-guidelines.md | 70 +- .../extension-dev-guide/code-generation.md | 20 +- .../sensitive-and-environment-settings.md | 34 +- guides/v2.2/extension-dev-guide/depend-inj.md | 12 +- .../v2.2/extension-dev-guide/indexer-batch.md | 8 +- .../extension-dev-guide/indexing-custom.md | 32 +- guides/v2.2/extension-dev-guide/indexing.md | 20 +- .../intro/developers_roadmap.md | 16 +- .../intro/intro-composer-gloss.md | 24 +- .../intro/intro-composer.md | 8 +- .../message-queues/bulk-operations.md | 4 +- .../message-queues/queue-migration.md | 4 +- .../extension-dev-guide/package/package.md | 6 +- .../prepare/dev-summary.md | 14 +- .../extension-dev-guide/prepare/lifecycle.md | 2 +- .../extension-dev-guide/prepare/prepare.md | 8 +- .../validate/test-module.md | 12 +- .../bk-frontend-dev-guide.md | 24 +- .../css-guide/css_quick_guide_overview.md | 8 +- .../css-topics/custom_preprocess.md | 6 +- .../css-topics/gulp-sass.md | 10 +- .../css-topics/theme-ui-lib.md | 34 +- .../layouts/layout-extend.md | 16 +- .../layouts/layout-override.md | 36 +- .../layouts/layout-overview.md | 8 +- .../responsive-web-design/rwd-breakpoints.md | 4 +- .../responsive-web-design/rwd_js.md | 2 +- .../responsive-web-design/rwd_overview.md | 2 +- .../frontend-dev-guide/themes/theme-apply.md | 4 +- .../frontend-dev-guide/themes/theme-create.md | 14 +- .../frontend-dev-guide/themes/theme-images.md | 8 +- .../themes/theme-structure.md | 46 +- .../frontend-dev-guide/tools/using_grunt.md | 92 +- .../translations/theme_dictionary.md | 20 +- .../frontend-dev-guide/translations/xlate.md | 36 +- guides/v2.2/get-started/bk-get-started-api.md | 6 +- .../get-started/web-api-functional-testing.md | 8 +- .../v2.2/howdoi/checkout/checkout_new_step.md | 30 +- guides/v2.2/howdoi/checkout/checkout_zip.md | 20 +- .../howdoi/customize-form-configuration.md | 2 +- guides/v2.2/howdoi/php/php_clear-dirs.md | 6 +- guides/v2.2/install-gde/back-intro.md | 10 +- .../v2.2/install-gde/basics/basics_login.md | 22 +- .../basics/basics_magento-installed.md | 14 +- .../v2.2/install-gde/basics/basics_module.md | 6 +- .../install-gde/basics/basics_os-version.md | 24 +- .../install-gde/basics/basics_software.md | 8 +- guides/v2.2/install-gde/bk-install-guide.md | 86 +- .../install-gde/continue-to-cm-updater.md | 4 +- .../v2.2/install-gde/continue-to-install.md | 8 +- guides/v2.2/install-gde/continue-to-verify.md | 8 +- .../install-gde/continue-to-verify_cli.md | 6 +- .../install-gde/install-resources-parent.md | 6 +- .../v2.2/install-gde/install-roadmap_cli.md | 26 +- .../v2.2/install-gde/install-roadmap_part1.md | 26 +- .../install-gde/install-roadmap_trouble.md | 26 +- .../v2.2/install-gde/install-roadmap_web.md | 26 +- .../install-gde/install/cli/dev_downgrade.md | 56 +- .../install-gde/install/cli/dev_options.md | 8 +- .../install-gde/install/cli/dev_reinstall.md | 30 +- .../install/cli/dev_update-magento.md | 12 +- .../install/cli/install-cli-adminurl.md | 4 +- .../install/cli/install-cli-backup.md | 12 +- .../install/cli/install-cli-install.md | 90 +- .../install/cli/install-cli-sample-data.md | 4 +- .../cli/install-cli-subcommands-db-status.md | 36 +- .../cli/install-cli-subcommands-db-upgr.md | 12 +- .../install/cli/install-cli-subcommands-db.md | 6 +- .../cli/install-cli-subcommands-deployment.md | 44 +- .../cli/install-cli-subcommands-enable.md | 20 +- .../cli/install-cli-subcommands-lock.md | 4 +- .../cli/install-cli-subcommands-maint.md | 50 +- .../cli/install-cli-subcommands-store.md | 6 +- .../install/cli/install-cli-subcommands.md | 8 +- .../cli/install-cli-theme-uninstall.md | 82 +- .../cli/install-cli-uninstall-langpk.md | 40 +- .../install/cli/install-cli-uninstall-mods.md | 156 ++-- .../install-gde/install/cli/install-cli.md | 4 +- .../install/hosted/hosted_get-ftp.md | 50 +- .../install/hosted/hosted_start.md | 6 +- .../install/hosted/hosted_start_db.md | 10 +- .../install/hosted/hosted_start_php.md | 12 +- .../install/hosted/post-install-config.md | 32 +- .../install/legacy-file-system-perms.md | 54 +- .../install/post-install-config.md | 32 +- .../install/sample-data-after-magento.md | 4 +- .../install/web/install-web-sample-data.md | 4 +- guides/v2.2/install-gde/prereq/apache.md | 140 ++-- .../v2.2/install-gde/prereq/connect-auth.md | 10 +- .../install-gde/prereq/install-rabbitmq.md | 16 +- .../v2.2/install-gde/prereq/merch_install.md | 12 +- guides/v2.2/install-gde/prereq/mysql.md | 268 +++--- .../v2.2/install-gde/prereq/mysql_remote.md | 100 +-- guides/v2.2/install-gde/prereq/nginx.md | 230 ++--- guides/v2.2/install-gde/prereq/optional.md | 146 ++-- guides/v2.2/install-gde/prereq/php-centos.md | 116 +-- .../v2.2/install-gde/prereq/php-settings.md | 96 +-- guides/v2.2/install-gde/prereq/php-ubuntu.md | 70 +- .../install-gde/prereq/prereq-overview.md | 66 +- guides/v2.2/install-gde/prereq/security.md | 40 +- .../v2.2/install-gde/system-requirements.md | 8 +- .../system-requirements_repo-tls1-2.md | 6 +- .../trouble/git/tshoot_git-main.md | 4 +- .../trouble/git/tshoot_git-pull-origin.md | 28 +- .../install-gde/trouble/php/tshoot_70pct.md | 40 +- .../trouble/php/tshoot_access-main.md | 14 +- .../trouble/php/tshoot_install-main.md | 18 +- .../install-gde/trouble/php/tshoot_mcrypt.md | 6 +- .../trouble/php/tshoot_mod_access_compat.md | 14 +- .../trouble/php/tshoot_nginx-port.md | 6 +- .../install-gde/trouble/php/tshoot_opcache.md | 38 +- .../install-gde/trouble/php/tshoot_pdo.md | 2 +- .../trouble/php/tshoot_php-date.md | 2 +- .../trouble/php/tshoot_php-main.md | 8 +- .../install-gde/trouble/php/tshoot_php-set.md | 32 +- .../install-gde/trouble/php/tshoot_phpini.md | 20 +- .../install-gde/trouble/php/tshoot_session.md | 24 +- .../install-gde/trouble/php/tshoot_xdebug.md | 2 +- .../trouble/readiness/tshoot_rc_cron.md | 12 +- .../trouble/readiness/tshoot_rc_main.md | 8 +- .../trouble/tshoot_access-browser.md | 18 +- .../trouble/tshoot_bundlesampledata.md | 26 +- .../trouble/tshoot_composer-fail.md | 26 +- .../install-gde/trouble/tshoot_exceptions.md | 28 +- .../install-gde/trouble/tshoot_install-log.md | 18 +- .../trouble/tshoot_mysql_table-open-cache.md | 24 +- .../install-gde/trouble/tshoot_no-styles.md | 4 +- .../install-gde/trouble/tshoot_sample-data.md | 42 +- .../install-gde/trouble/tshoot_segfault.md | 14 +- .../javascript/custom_js.md | 4 +- .../javascript/js-resources.md | 6 +- .../widgets/widget_calendar.md | 20 +- guides/v2.2/migration/migration-manually.md | 22 +- .../migration/migration-tool-configure.md | 100 +-- .../v2.2/migration/migration-tool-install.md | 42 +- .../migration/migration-tool-preconditions.md | 12 +- .../v2.2/migration/migration-tool-upgrade.md | 22 +- .../pattern-library/containers/tabs/tabs.md | 18 +- .../controls/buttons/buttons.md | 84 +- .../displaying-data/datatable/datatable.md | 4 +- .../date_time_selector/date_time_selector.md | 96 +-- .../graphics/iconography/iconography.md | 20 +- .../templates/address-form/address-form.md | 74 +- .../base-integration/formblocktype.md | 2 +- .../payment-gateway/command-pool.md | 2 +- .../introduction.md | 4 +- .../v2.2/release-notes/ReleaseNotes2.2.0CE.md | 14 +- .../v2.2/release-notes/ReleaseNotes2.2.0EE.md | 16 +- .../v2.2/release-notes/ReleaseNotes2.2.6CE.md | 36 +- .../v2.2/release-notes/ReleaseNotes2.2.6EE.md | 36 +- .../v2.2/release-notes/ReleaseNotes2.2.8CE.md | 8 +- .../v2.2/release-notes/ReleaseNotes2.2.8EE.md | 8 +- .../v2.2/release-notes/ReleaseNotes2.2.9CE.md | 12 +- .../ReleaseNotesMagentoShipping2.2.x.md | 12 +- guides/v2.2/release-notes/bk-release-notes.md | 8 +- guides/v2.2/rest/bulk-endpoints.md | 48 +- .../create-configurable-product.md | 68 +- .../create-simple-products.md | 84 +- .../define-config-product-options.md | 2 +- .../tutorials/orders/order-create-customer.md | 40 +- .../tutorials/orders/order-create-order.md | 32 +- .../orders/order-prepare-checkout.md | 4 +- .../v2.2/test/unit/unit_test_execution_cli.md | 12 +- .../test/unit/unit_test_execution_phpstorm.md | 38 +- .../components/ui-dynamicrows.md | 4 +- .../concepts/ui_comp_uicollection_concept.md | 6 +- .../ui_comp_xmldeclaration_concept.md | 2 +- .../howto/new_component_declaration.md | 4 +- guides/v2.3/architecture/tech-stack.md | 20 +- .../before-workspace-magento-prereqs.md | 86 +- guides/v2.3/cloud/live/go-live-checklist.md | 28 +- guides/v2.3/cloud/live/live-sanity-check.md | 72 +- .../cloud/requirements/cloud-requirements.md | 76 +- guides/v2.3/cloud/setup/first-time-deploy.md | 48 +- .../code-standard-demarcation.md | 8 +- guides/v2.3/config-guide/bk-config-guide.md | 40 +- .../cli/config-cli-subcommands-i18n.md | 8 +- .../cli/config-cli-subcommands-perf-data.md | 28 +- .../deployment/pipeline/build-system.md | 76 +- .../elasticsearch/es-config-apache.md | 146 ++-- .../elasticsearch/es-config-nginx.md | 146 ++-- .../elasticsearch/es-config-stopwords.md | 76 +- .../v2.3/config-guide/mq/rabbitmq-overview.md | 6 +- .../prod/config-reference-gitignore.md | 12 +- .../prod/config-reference-sens.md | 10 +- guides/v2.3/extension-dev-guide/attributes.md | 2 +- .../bk-extension-dev-guide.md | 6 +- .../build/module-file-structure.md | 20 +- .../build/required-configuration-files.md | 24 +- guides/v2.3/extension-dev-guide/depend-inj.md | 12 +- .../v2.3/extension-dev-guide/indexer-batch.md | 8 +- guides/v2.3/extension-dev-guide/indexing.md | 20 +- .../message-queues/bulk-operations.md | 4 +- .../message-queues/config-mq.md | 6 +- .../message-queues/queue-migration.md | 4 +- .../validate/test-module.md | 12 +- .../frontend-dev-guide/themes/theme-create.md | 14 +- .../frontend-dev-guide/translations/xlate.md | 38 +- .../get-started/web-api-functional-testing.md | 4 +- guides/v2.3/graphql/develop/resolvers.md | 2 +- .../v2.3/graphql/reference/bundle-product.md | 2 +- .../v2.3/graphql/reference/grouped-product.md | 4 +- .../product-interface-implementations.md | 4 +- guides/v2.3/graphql/reference/store-config.md | 14 +- guides/v2.3/install-gde/install-quick-ref.md | 134 +-- .../install/hosted/hosted_get-ftp.md | 34 +- .../install/post-install-config.md | 32 +- guides/v2.3/install-gde/prereq/apache.md | 140 ++-- .../install-gde/prereq/install-rabbitmq.md | 14 +- guides/v2.3/install-gde/prereq/mysql.md | 266 +++--- .../v2.3/install-gde/prereq/mysql_remote.md | 94 +-- guides/v2.3/install-gde/prereq/nginx.md | 190 ++--- guides/v2.3/install-gde/prereq/optional.md | 146 ++-- .../v2.3/install-gde/prereq/php-settings.md | 88 +- guides/v2.3/install-gde/prereq/security.md | 38 +- guides/v2.3/install-gde/prereq/zip_install.md | 56 +- .../v2.3/install-gde/system-requirements.md | 8 +- .../install-gde/trouble/php/tshoot_pdo.md | 2 +- .../trouble/tshoot_access-browser.md | 14 +- .../widgets/widget_calendar.md | 20 +- .../introduction.md | 4 +- .../ReleaseNotes2.3.0Commerce.md | 24 +- .../ReleaseNotes2.3.0OpenSource.md | 24 +- .../ReleaseNotes2.3.1Commerce.md | 14 +- .../ReleaseNotes2.3.1OpenSource.md | 14 +- .../ReleaseNotes2.3.2OpenSource.md | 22 +- guides/v2.3/release-notes/bk-release-notes.md | 8 +- guides/v2.3/rest/bulk-endpoints.md | 48 +- .../modules/inventory/link-stocks-sources.md | 6 +- .../modules/inventory/manage-low-quantity.md | 18 +- .../modules/inventory/manage-source-items.md | 50 +- .../inventory/manage-source-selection.md | 14 +- .../rest/modules/inventory/manage-sources.md | 28 +- .../create-configurable-simple-products.md | 320 +++---- .../rest/tutorials/inventory/create-order.md | 32 +- .../reassign-products-to-another-source.md | 112 +-- whats-new.md | 2 +- 469 files changed, 7817 insertions(+), 7835 deletions(-) diff --git a/_includes/browsers/supported-browsers.md b/_includes/browsers/supported-browsers.md index b3b10706709..e485fa7fb5a 100644 --- a/_includes/browsers/supported-browsers.md +++ b/_includes/browsers/supported-browsers.md @@ -1,11 +1,11 @@ Storefront and Admin: -* Internet Explorer 11 or later, Microsoft Edge, latest–1 -* Firefox latest, latest–1 (any operating system) -* Chrome latest, latest–1 (any operating system) -* Safari latest, latest–1 (Mac OS only) -* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront -* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront -* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront +* Internet Explorer 11 or later, Microsoft Edge, latest–1 +* Firefox latest, latest–1 (any operating system) +* Chrome latest, latest–1 (any operating system) +* Safari latest, latest–1 (Mac OS only) +* Safari Mobile for iPad 2, iPad Mini, iPad with Retina Display (iOS 7 or later), for desktop storefront +* Safari Mobile for iPhone 4 or later; iOS 7 or later, for mobile storefront +* Chrome for mobile latest–1 (Android 4 or later) for mobile storefront Here, _latest–1_ means one major version earlier than the latest released version. diff --git a/_includes/cloud/cli-get-started.md b/_includes/cloud/cli-get-started.md index 428f7c8a851..9a646497808 100644 --- a/_includes/cloud/cli-get-started.md +++ b/_includes/cloud/cli-get-started.md @@ -1,35 +1,35 @@ -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: +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: - magento-cloud login -3. List your projects. With the project ID, you can complete additional commands. + magento-cloud login +3. List your projects. With the project ID, you can complete additional commands. - magento-cloud project:list -4. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace. + magento-cloud project:list +4. If necessary, clone the project to your local. You should have cloned when setting up your local development workspace. - magento-cloud project:get + magento-cloud project:get -4. Change to a project directory. For example, `cd /var/www/html/magento2` -4. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services. +4. Change to a project directory. For example, `cd /var/www/html/magento2` +4. List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services. - magento-cloud environment:list + magento-cloud environment:list {: .bs-callout .bs-callout-info} - `magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not. + `magento-cloud environment:list`—displays environment hierarchies whereas the `git branch` command does not. -5. Fetch origin branches to get the latest code: +5. Fetch origin branches to get the latest code: - git fetch origin -6. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment. + git fetch origin +6. Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment. - magento-cloud environment:checkout + magento-cloud environment:checkout - To create a new environment, use `magento-cloud environment:branch ` -8. Pull any updated code to your local for the environment ID (which is the Git branch): + To create a new environment, use `magento-cloud environment:branch ` +8. Pull any updated code to your local for the environment ID (which is the Git branch): - git pull origin + git pull origin 7. Create a [snapshot]({{ page.baseurl }}/cloud/project/project-webint-snap.html) of the environment as a backup: magento-cloud snapshot:create -e \ No newline at end of file diff --git a/_includes/cloud/cloud-fastly-manage-vcl-from-admin.md b/_includes/cloud/cloud-fastly-manage-vcl-from-admin.md index 1a285cbbec8..8962258f9da 100644 --- a/_includes/cloud/cloud-fastly-manage-vcl-from-admin.md +++ b/_includes/cloud/cloud-fastly-manage-vcl-from-admin.md @@ -23,11 +23,11 @@ You can delete custom VCL snippet code from your Fastly configuration by uploadi - Upload an empty version of the snippet file to Fastly to remove the VCL logic from the active VCL version: - - Edit the snippet and delete the **VCL** snippet content. + - Edit the snippet and delete the **VCL** snippet content. - - Save the configuration. + - Save the configuration. - - Upload the VCL to Fastly to apply your changes. + - Upload the VCL to Fastly to apply your changes. - Use the Fastly API [Delete custom VCL snippet]({{ page.baseurl }}/cloud/cdn/cloud-vcl-custom-snippets.html#manage-vcl) operation to delete the snippet completely, or submit a Magento support ticket to request deletion. diff --git a/_includes/cloud/composer-name.md b/_includes/cloud/composer-name.md index 4d5b73dbc57..39d4a1d32ff 100644 --- a/_includes/cloud/composer-name.md +++ b/_includes/cloud/composer-name.md @@ -2,23 +2,23 @@ This section discusses how to get a module's Composer name and its version from #### To get the module's Composer name from Magento Marketplace: -1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component. -2. In the upper right corner, click **<your username>** > **My Account** as the following figure shows. +1. Log in to [Magento Marketplace](https://marketplace.magento.com) with the username and password you used to purchase the component. +2. In the upper right corner, click **<your username>** > **My Account** as the following figure shows. - ![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. + ![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"} -4. On the My Purchases page, click **Technical Details** for the module you purchased as the following figure shows. + ![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"} -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. -6. Append a colon character (`:`) to the component name. -7. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard. -8. Append the version number to the component name after the colon. + ![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. +6. Append a colon character (`:`) to the component name. +7. In **Technical Details** on the My Purchases page, click **Copy** to copy the version to the clipboard. +8. Append the version number to the component name after the colon. - A sample follows: + A sample follows: - pixlee/magento2:1.0.1 + pixlee/magento2:1.0.1 diff --git a/_includes/cloud/enable-ssh.md b/_includes/cloud/enable-ssh.md index 59ed56d6990..7ff1d149379 100644 --- a/_includes/cloud/enable-ssh.md +++ b/_includes/cloud/enable-ssh.md @@ -7,9 +7,9 @@ The SSH keys require the following: For more information on SSH keys, see the following: -* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) -* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows) -* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen) +* [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) +* [Manually generating your SSH key in Windows](https://docs.joyent.com/public-cloud/getting-started/ssh-keys/generating-an-ssh-key-manually/manually-generating-your-ssh-key-in-windows) +* [ssh-keygen man page](http://linux.die.net/man/1/ssh-keygen) ## Locate an existing SSH key pair {#existing} @@ -19,11 +19,11 @@ You can quickly verify if you have SSH keys by entering commands using terminal To check for SSH keys, enter the following command: - ls ~/.ssh + ls ~/.ssh If you have SSH keys, a directory listing is displayed similar to the following: - id_rsa id_rsa.pub known_hosts + id_rsa id_rsa.pub known_hosts If you do not have SSH keys, you need to generate the keys for adding to your Magento ECE account and GitHub account. See [Create a new SSH key pair](#ssh-create-new-key-pair). @@ -94,7 +94,7 @@ After adding the SSH keys, test the SSH connection to GitHub: 1. In the terminal, enter the following command: - ssh -T git@github.com + ssh -T git@github.com 2. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue. @@ -104,23 +104,23 @@ After adding the SSH keys, test the SSH connection to GitHub: You can add SSH keys to your account in any of the following ways: -* Using the [{{site.data.var.ece}} CLI](#add-key-cli) -* Using the [{{site.data.var.ece}} Web Interface](#add-key-web) +* Using the [{{site.data.var.ece}} CLI](#add-key-cli) +* Using the [{{site.data.var.ece}} Web Interface](#add-key-web) ### Add a key using the CLI {#add-key-cli} 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. +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. -3. Log in to your project: +3. Log in to your project: - magento-cloud login + magento-cloud login -3. Add the key: +3. Add the key: - magento-cloud ssh-key:add ~/.ssh/id_rsa.pub + magento-cloud ssh-key:add ~/.ssh/id_rsa.pub #### Add a key using the Project Web Interface {#add-key-web} @@ -131,17 +131,17 @@ You will select and add your SSH public key to each environment in your account. To add an SSH key using the Project Web Interface: -1. Copy your SSH public key to the clipboard. +1. Copy your SSH public key to the clipboard. - If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them. -2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud). -3. In your selected branch, an icon displays if you do not have an SSH key added. + If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them. +2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud). +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) -4. Copy and paste the content of your public SSH key in the screen. + ![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) -5. Follow the prompts on your screen to complete the task. + ![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 @@ -149,7 +149,7 @@ Set required global Git variables on the machine to commit or push to a Git bran To set variables, enter the following commands on every workspace: - git config --global user.name "" - git config --global user.email + git config --global user.name "" + git config --global user.email For more information, see [First-Time Git Setup](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_first_time) diff --git a/_includes/cloud/new-project-from-template.md b/_includes/cloud/new-project-from-template.md index 0296cb974db..00e276ba042 100644 --- a/_includes/cloud/new-project-from-template.md +++ b/_includes/cloud/new-project-from-template.md @@ -1,24 +1,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 {{site.data.var.ee}} account](https://accounts.magento.cloud). 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**. - ![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. + 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. \ No newline at end of file diff --git a/_includes/cloud/patch.md b/_includes/cloud/patch.md index f7fb7b3b93a..8523189d046 100644 --- a/_includes/cloud/patch.md +++ b/_includes/cloud/patch.md @@ -98,25 +98,25 @@ We recommend you test a patch in the `master` branch. To test a general patch on your local system: -1. On your local system, enter the following commands as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html): +1. On your local system, enter the following commands as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html): - cd - magento-cloud environment:checkout master - git pull origin master - composer update -2. Apply the patch locally: + cd + magento-cloud environment:checkout master + git pull origin master + composer update +2. Apply the patch locally: - git apply vendor/magento/magento-cloud-configuration/patches/ -3. Clean the Magento cache: + git apply vendor/magento/magento-cloud-configuration/patches/ +3. Clean the Magento cache: - php /bin/magento cache:clean + php /bin/magento cache:clean - You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). -4. Thoroughly test your local system to make sure the patch doesn't have unexpected side-affects. -5. After testing the patch, push it to the remote server and deploy it: + You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). +4. Thoroughly test your local system to make sure the patch doesn't have unexpected side-affects. +5. After testing the patch, push it to the remote server and deploy it: - git add -A && git commit -m "Apply patch" - git push origin + git add -A && git commit -m "Apply patch" + git push origin ### Push a general patch to the staging or production environment {#gen-pushpatch} @@ -126,22 +126,22 @@ After you've successfully tested a patch locally and on your integration environ * Staging: `ssh -A _stg@.ent.magento.cloud` * Production: `ssh -A @.ent.magento.cloud` -2. Enter the following commands: +2. Enter the following commands: - /composer update -2. Apply the patch locally: + /composer update +2. Apply the patch locally: - git apply vendor/magento/magento-cloud-configuration/patches/ -3. Clean the Magento cache: + git apply vendor/magento/magento-cloud-configuration/patches/ +3. Clean the Magento cache: - php /bin/magento cache:clean + php /bin/magento cache:clean - You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). -3. Thoroughly test your local system to make sure the patch doesn't have unexpected side-affects. -4. After testing the patch, push it to the remote server and deploy it: + You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). +3. Thoroughly test your local system to make sure the patch doesn't have unexpected side-affects. +4. After testing the patch, push it to the remote server and deploy it: - git add -A && git commit -m "Apply patch" - git push origin master + git add -A && git commit -m "Apply patch" + git push origin master ## Test custom patches {#cloud-patch-custom} @@ -159,25 +159,25 @@ We recommend you test a patch locally in the `master` branch. To test a custom patch on your local system: -1. On your local system, enter the following command as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) if you haven't done so already: +1. On your local system, enter the following command as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) if you haven't done so already: - mkdir /m2-hotfixes -3. Copy the patch file to that directory. -2. Apply the patch locally: + mkdir /m2-hotfixes +3. Copy the patch file to that directory. +2. Apply the patch locally: - cd - magento-cloud environment:checkout master - git pull origin master - git apply /m2-hotfixes/ -3. Clean the Magento cache: + cd + magento-cloud environment:checkout master + git pull origin master + git apply /m2-hotfixes/ +3. Clean the Magento cache: - php /bin/magento cache:clean + php /bin/magento cache:clean - You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). -4. After testing the patch, push it to the remote server and deploy it: + You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). +4. After testing the patch, push it to the remote server and deploy it: - git add -A && git commit -m "Apply patch" - git push origin + git add -A && git commit -m "Apply patch" + git push origin ### Push a custom patch to a staging or production environment {#custom-pushpatch} @@ -187,35 +187,35 @@ After you've successfully tested a custom patch locally and on your integration * Staging: `ssh -A _stg@.ent.magento.cloud` * Production: `ssh -A @.ent.magento.cloud` -2. On your staging or production system, enter the following command if you haven't done so already: +2. On your staging or production system, enter the following command if you haven't done so already: - mkdir /m2-hotfixes -3. Copy the patch file to that directory. + mkdir /m2-hotfixes +3. Copy the patch file to that directory. - We suggest using the following command: + We suggest using the following command: - rsync -azvP + rsync -azvP - Options: + Options: - `a` archive + `a` archive - `z` compress + `z` compress - `v` verbose + `v` verbose - `P` partial progress + `P` partial progress - For additional options, see the [rsync man page](http://linux.die.net/man/1/rsync). -2. Apply the patch: + For additional options, see the [rsync man page](http://linux.die.net/man/1/rsync). +2. Apply the patch: - git apply /m2-hotfixes/ -3. Clean the Magento cache: + git apply /m2-hotfixes/ +3. Clean the Magento cache: - php /bin/magento cache:clean + php /bin/magento cache:clean - You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). -4. After testing the patch, push it to the remote server and deploy it: + You can also clean the cache using the [Magento Admin](http://docs.magento.com/m2/ee/user_guide/system/cache-management.html). +4. After testing the patch, push it to the remote server and deploy it: - git add -A && git commit -m "Apply patch" - git push origin \ No newline at end of file + git add -A && git commit -m "Apply patch" + git push origin \ No newline at end of file diff --git a/_includes/cloud/ssh-tunnel.md b/_includes/cloud/ssh-tunnel.md index 3c991220f5c..d27f17a441f 100644 --- a/_includes/cloud/ssh-tunnel.md +++ b/_includes/cloud/ssh-tunnel.md @@ -6,13 +6,13 @@ Use a terminal application to log in and issue commands. First, you may want to check if any tunnels are already open using the following command: - magento-cloud tunnel:list + 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 - magento-cloud project:list - magento-cloud apps + cd + magento-cloud project:list + magento-cloud apps For information on the command, you can enter `magento-cloud apps --help`. @@ -20,28 +20,28 @@ For information on the command, you can enter `magento-cloud apps --help`. Use the following command: - magento-cloud tunnel:open -e --app + magento-cloud tunnel:open -e --app 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 + 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 + 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 + 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 + magento-cloud tunnel:info -e ### Connect to services {#tunnel-services} @@ -49,6 +49,6 @@ 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='' --pass='' --database='' --port='' + mysql --host=127.0.0.1 --user='' --pass='' --database='' --port='' Details about the service display if you use the `magento-cloud tunnel:info` command. \ No newline at end of file diff --git a/_includes/comp-man/backup.md b/_includes/comp-man/backup.md index 604638467e3..55c50522f8e 100644 --- a/_includes/comp-man/backup.md +++ b/_includes/comp-man/backup.md @@ -1,8 +1,8 @@ After you pass all readiness checks, you can back up: -* The Magento 2 file system (excluding `var` and `pub/static` directories) -* The `pub/media` directory -* The Magento 2 database +* The Magento 2 file system (excluding `var` and `pub/static` directories) +* The `pub/media` directory +* The Magento 2 database Backups are stored in the `var/backups` directory and can be restored at any time using the [`magento setup:rollback`]({{ page.baseurl }}/install-gde/install/cli/install-cli-uninstall-mods.html#instgde-cli-uninst-mod-roll) or using the Magento Admin. @@ -11,18 +11,18 @@ Magento backup features must be enabled. For more information and commands, see To back up: -1. Select the checkbox of each item to back up and click **Create Backup**. +1. Select the checkbox of each item to back up and click **Create Backup**. - The following figure shows an example of backing up everything. + The following figure shows an example of backing up everything. - ![You can back up the Magento 2 file system, media directory, and database]({{ site.baseurl }}/common/images/modman_create-backup.png){:width="550px"} + ![You can back up the Magento 2 file system, media directory, and database]({{ site.baseurl }}/common/images/modman_create-backup.png){:width="550px"} - (If you choose not to back up, clear all checkboxes and click **Next**.) + (If you choose not to back up, clear all checkboxes and click **Next**.) - {:.bs-callout .bs-callout-info} + {:.bs-callout .bs-callout-info} We strongly recommend you do back up in the event of issues. -2. Wait while backups are created and continue with any of the following: +2. Wait while backups are created and continue with any of the following: The following page displays to confirm a successful backup. diff --git a/_includes/comp-man/checklist.md b/_includes/comp-man/checklist.md index 506c3070082..7ab692aed87 100644 --- a/_includes/comp-man/checklist.md +++ b/_includes/comp-man/checklist.md @@ -1,8 +1,8 @@ Before you continue, to avoid errors during your installation or update, make sure you verify *all* of the following: -* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group -* Your [cron jobs](#magento-cron) are set up and running -* [File system permissions](#perms) are set properly +* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group +* Your [cron jobs](#magento-cron) are set up and running +* [File system permissions](#perms) are set properly {:.bs-callout .bs-callout-warning} Do not continue without performing these checks. Failure to do so could result in errors. @@ -17,17 +17,17 @@ Magento requires three cron jobs, all running as the [Magento file system owner] To verify your cron jobs are set up properly, enter the following command as a user with `root` privileges: - crontab -u -l + crontab -u -l For example, if your Magento file system owner is named `magento_user`, enter: - crontab -u magento_user -l + crontab -u magento_user -l Results similar to the following should display: - * * * * * /usr/bin/php /var/www/magento2/bin/magento cron:run | grep -v "Ran jobs by schedule" >> /var/www/magento2/var/log/magento.cron.log - * * * * * /usr/bin/php /var/www/magento2/update/cron.php >> /var/www/magento2/var/log/update.cron.log - * * * * * /usr/bin/php /var/www/magento2/bin/magento setup:cron:run >> /var/www/magento2/var/log/setup.cron.log + * * * * * /usr/bin/php /var/www/magento2/bin/magento cron:run | grep -v "Ran jobs by schedule" >> /var/www/magento2/var/log/magento.cron.log + * * * * * /usr/bin/php /var/www/magento2/update/cron.php >> /var/www/magento2/var/log/update.cron.log + * * * * * /usr/bin/php /var/www/magento2/bin/magento setup:cron:run >> /var/www/magento2/var/log/setup.cron.log Another symptom of cron not running is the following error in the Magento Admin: @@ -49,7 +49,7 @@ To verify your file system permissions are set properly, either log in to the Ma For example, enter the following commands on a Linux system if the Magento application is installed in `/var/www/html/magento2`: - ls -al /var/www/html/magento2 + ls -al /var/www/html/magento2 A sample result follows: @@ -92,7 +92,7 @@ In the preceding example, the Magento file system owner is `magento_user`. Direc To get more detailed information, you can optionally enter the following command: - ls -al /var/www/html/magento2/pub + ls -al /var/www/html/magento2/pub Because Magento deploys static file assets to subdirectories of `pub`, it's a good idea to verify permissions and ownership there as well. diff --git a/_includes/comp-man/checklist_2.2.md b/_includes/comp-man/checklist_2.2.md index 27b4c42892f..8514096123f 100644 --- a/_includes/comp-man/checklist_2.2.md +++ b/_includes/comp-man/checklist_2.2.md @@ -1,9 +1,9 @@ Before you continue, to avoid errors during your installation or update, make sure you verify *all* of the following: -* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group -* Your [cron jobs](#magento-cron) are set up and running -* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size) -* [File system permissions](#perms) are set properly +* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group +* Your [cron jobs](#magento-cron) are set up and running +* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size) +* [File system permissions](#perms) are set properly {:.bs-callout .bs-callout-warning} Do not continue without performing these checks. Failure to do so could result in errors. diff --git a/_includes/comp-man/readiness-check.md b/_includes/comp-man/readiness-check.md index 1d5e1707147..efb4807346f 100644 --- a/_includes/comp-man/readiness-check.md +++ b/_includes/comp-man/readiness-check.md @@ -1,7 +1,7 @@ After the readiness check completes, see one of the following: -* [Readiness check success](#compman-readiness-success) -* [Readiness check failure](#compman-readiness-fail) +* [Readiness check success](#compman-readiness-success) +* [Readiness check failure](#compman-readiness-fail) ### Readiness check success {#compman-readiness-success} @@ -17,9 +17,9 @@ Messages similar to the following display if any readiness check fails. In the event of failure, see one of the following sections: -* [Updater check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) -* [Cron script check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) -* [Component dependency check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) -* [PHP version readiness check issues]({{ page.baseurl }}/comp-mgr/trouble/cman/php-version.html) -* [PHP settings errors]({{ page.baseurl }}/install-gde/trouble/php/tshoot_php-set.html) -* [PHP extensions check failure]({{ page.baseurl }}/install-gde/system-requirements.html) +* [Updater check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) +* [Cron script check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) +* [Component dependency check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) +* [PHP version readiness check issues]({{ page.baseurl }}/comp-mgr/trouble/cman/php-version.html) +* [PHP settings errors]({{ page.baseurl }}/install-gde/trouble/php/tshoot_php-set.html) +* [PHP extensions check failure]({{ page.baseurl }}/install-gde/system-requirements.html) diff --git a/_includes/config/cron-overview.md b/_includes/config/cron-overview.md index 62decd038b8..f45c8fdc8aa 100644 --- a/_includes/config/cron-overview.md +++ b/_includes/config/cron-overview.md @@ -1,13 +1,13 @@ Several Magento features require at least one cron job, which schedules activities to occur in the future. A partial list of these activities follows: -* Catalog price rules -* Newsletters -* Generating Google sitemaps -* Customer Alerts/Notifications (product price change, product back in stock) -* Reindexing -* Private sales ({{site.data.var.ee}} only) -* Automatic updating of currency rates -* All Magento e-mails (including order confirmation and transactional) +* Catalog price rules +* Newsletters +* Generating Google sitemaps +* Customer Alerts/Notifications (product price change, product back in stock) +* Reindexing +* Private sales ({{site.data.var.ee}} only) +* Automatic updating of currency rates +* All Magento e-mails (including order confirmation and transactional) We recommend you run cron as the [Magento file system owner]({{ page.baseurl }}/config-guide/cli/config-cli.html#config-install-cli-first). Do *not* run cron as `root`; we also recommend against running cron as the web server user. diff --git a/_includes/config/es-verify-proxy.md b/_includes/config/es-verify-proxy.md index 4b145a95aab..ad7ff8affbc 100644 --- a/_includes/config/es-verify-proxy.md +++ b/_includes/config/es-verify-proxy.md @@ -2,8 +2,8 @@ This section discusses two ways to verify that HTTP Basic authentication is working: -* Using a `curl` command to verify you must enter a username and password to get cluster status -* Configuring HTTP Basic authentication in the Magento Admin +* Using a `curl` command to verify you must enter a username and password to get cluster status +* Configuring HTTP Basic authentication in the Magento Admin ### Use a `curl` command to verify cluster status diff --git a/_includes/config/es-webserver-overview.md b/_includes/config/es-webserver-overview.md index 9be99a43a18..667042ea3ba 100644 --- a/_includes/config/es-webserver-overview.md +++ b/_includes/config/es-webserver-overview.md @@ -11,26 +11,26 @@ Unless otherwise noted, all commands in this topic must be entered as a user wit We recommend the following: -* Your web server uses TLS. +* Your web server uses TLS. - TLS is beyond the scope of this topic; however, we strongly recommend you use a real certificate in production and not a self-signed certificate. -* Elasticsearch runs on the same host as a web server. Running Elasticsearch and the web server on different hosts is beyond the scope of this topic. + TLS is beyond the scope of this topic; however, we strongly recommend you use a real certificate in production and not a self-signed certificate. +* Elasticsearch runs on the same host as a web server. Running Elasticsearch and the web server on different hosts is beyond the scope of this topic. - The advantage of putting Elasticsearch and the web server on the same host is that it makes intercepting encrypted communication impossible. The Elasticsearch web server doesn't have to be the same as the Magento web server; for example, Magento can run Apache and Elasticsearch can run nginx. + The advantage of putting Elasticsearch and the web server on the same host is that it makes intercepting encrypted communication impossible. The Elasticsearch web server doesn't have to be the same as the Magento web server; for example, Magento can run Apache and Elasticsearch can run nginx. ### More information about TLS See one of the following resources: -* Apache +* Apache - * [Apache 2.4 strong encryption how-to](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html) - * [Apache 2.2 SSL/TLS page](https://httpd.apache.org/docs/2.2/en/ssl/) - * [How To Create a SSL Certificate on Apache for Ubuntu 14.04 (Digitalocean tutorial)](https://www.digitalocean.com/community/tutorials/how-to-create-a-ssl-certificate-on-apache-for-ubuntu-14-04) - * [Setting up an SSL secured Webserver with CentOS (CentOS wiki)](https://wiki.centos.org/HowTos/Https) + * [Apache 2.4 strong encryption how-to](https://httpd.apache.org/docs/2.4/ssl/ssl_howto.html) + * [Apache 2.2 SSL/TLS page](https://httpd.apache.org/docs/2.2/en/ssl/) + * [How To Create a SSL Certificate on Apache for Ubuntu 14.04 (Digitalocean tutorial)](https://www.digitalocean.com/community/tutorials/how-to-create-a-ssl-certificate-on-apache-for-ubuntu-14-04) + * [Setting up an SSL secured Webserver with CentOS (CentOS wiki)](https://wiki.centos.org/HowTos/Https) -* Nginx +* Nginx - * [Nginx SSL termination](https://www.nginx.com/resources/admin-guide/nginx-ssl-termination/) - * [How To Create an SSL Certificate on Nginx for Ubuntu 14.04 (Digitalocean tutorial)](https://www.digitalocean.com/community/tutorials/how-to-create-an-ssl-certificate-on-nginx-for-ubuntu-14-04) - * [Nginx SSL Certificate Installation (digicert)](https://www.digicert.com/ssl-certificate-installation-nginx.htm) + * [Nginx SSL termination](https://www.nginx.com/resources/admin-guide/nginx-ssl-termination/) + * [How To Create an SSL Certificate on Nginx for Ubuntu 14.04 (Digitalocean tutorial)](https://www.digitalocean.com/community/tutorials/how-to-create-an-ssl-certificate-on-nginx-for-ubuntu-14-04) + * [Nginx SSL Certificate Installation (digicert)](https://www.digicert.com/ssl-certificate-installation-nginx.htm) diff --git a/_includes/config/install-java.md b/_includes/config/install-java.md index 0759a553015..1091ff6a34d 100644 --- a/_includes/config/install-java.md +++ b/_includes/config/install-java.md @@ -2,7 +2,7 @@ To determine if Java is already installed, enter the following command: - java -version + java -version If the message `java: command not found` displays, you must install the Java SDK as discussed in the next section. @@ -17,7 +17,7 @@ See [this article on digitalocean](https://www.digitalocean.com/community/tutori Be sure to install the JDK and *not* the JRE. - yum -y install java-1.7.0-openjdk + yum -y install java-1.7.0-openjdk {:.bs-callout .bs-callout-info} Java version 7 might not be available for all operating systems. For example, you can [search the list of available packages for Ubuntu](http://packages.ubuntu.com/). @@ -26,8 +26,8 @@ Java version 7 might not be available for all operating systems. For example, yo To install JDK 1.8 on Ubuntu, enter the following commands as a user with `root` privileges: - add-apt-repository -y ppa:webupd8team/java - apt-get -y update - apt-get install -y oracle-java8-installer + add-apt-repository -y ppa:webupd8team/java + apt-get -y update + apt-get install -y oracle-java8-installer For other options, see [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html). diff --git a/_includes/config/install-java8.md b/_includes/config/install-java8.md index be258663c7f..d1bd5a8cd02 100644 --- a/_includes/config/install-java8.md +++ b/_includes/config/install-java8.md @@ -2,7 +2,7 @@ To determine if Java is already installed, enter the following command: - java -version + java -version If the message `java: command not found` displays, you must install the Java SDK as discussed in the next section. @@ -17,7 +17,7 @@ See [this article on digitalocean](https://www.digitalocean.com/community/tutori Be sure to install the JDK and *not* the JRE. - yum -y install java-1.8.0-openjdk + yum -y install java-1.8.0-openjdk {:.bs-callout .bs-callout-info} Java version 8 might not be available for all operating systems. For example, you can [search the list of available packages for Ubuntu](http://packages.ubuntu.com/). @@ -26,8 +26,8 @@ Java version 8 might not be available for all operating systems. For example, yo To install JDK 1.8 on Ubuntu, enter the following commands as a user with `root` privileges: - add-apt-repository -y ppa:webupd8team/java - apt-get -y update - apt-get install -y oracle-java8-installer + add-apt-repository -y ppa:webupd8team/java + apt-get -y update + apt-get install -y oracle-java8-installer For other options, see [Oracle documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html). diff --git a/_includes/config/multi-site_verify.md b/_includes/config/multi-site_verify.md index d244854e07f..0debbd2ddb4 100644 --- a/_includes/config/multi-site_verify.md +++ b/_includes/config/multi-site_verify.md @@ -19,6 +19,6 @@ You're done! ### Troubleshooting -* If your French and German sites return 404s but your Admin loads, make sure you completed [Step 6: Add the store code to the base URL]({{ page.baseurl }}/config-guide/multi-site/ms_websites.html#multi-storecode-baseurl). -* If all URLs return 404s, make sure you restarted your web server. -* If the Magento Admin doesn't function properly, make sure you set up your virtual hosts properly. +* If your French and German sites return 404s but your Admin loads, make sure you completed [Step 6: Add the store code to the base URL]({{ page.baseurl }}/config-guide/multi-site/ms_websites.html#multi-storecode-baseurl). +* If all URLs return 404s, make sure you restarted your web server. +* If the Magento Admin doesn't function properly, make sure you set up your virtual hosts properly. diff --git a/_includes/config/php-memcache.md b/_includes/config/php-memcache.md index 26d28dc131d..13f5716316c 100644 --- a/_includes/config/php-memcache.md +++ b/_includes/config/php-memcache.md @@ -2,17 +2,17 @@ Because PHP has no native support for memcache, you must install an extension for PHP to use it. There are two PHP extensions available and it's important to decode which to use: -* `memcache` (no *d*), an older but very popular extension that is not maintained regularly. The `memcache` extension currently *does not* work with PHP 7. +* `memcache` (no *d*), an older but very popular extension that is not maintained regularly. The `memcache` extension currently *does not* work with PHP 7. - [PHP documentation for memcache](http://php.net/manual/en/book.memcache.php) + [PHP documentation for memcache](http://php.net/manual/en/book.memcache.php) - The exact name is `php5-memcache` for Ubuntu and `php-pecl-memcache` for CentOS + The exact name is `php5-memcache` for Ubuntu and `php-pecl-memcache` for CentOS -* `memcached` (with a `d`), a newer and maintained extension that should be compatible with PHP 7. +* `memcached` (with a `d`), a newer and maintained extension that should be compatible with PHP 7. - [PHP documentation for memcached](http://php.net/memcached) + [PHP documentation for memcached](http://php.net/memcached) - The exact name is `php5-memcached` for Ubuntu and `php-pecl-memcached` for CentOS + The exact name is `php5-memcached` for Ubuntu and `php-pecl-memcached` for CentOS {:.bs-callout .bs-callout-info} For simplicity, we use the PHP `memcache` extension in this guide although we provide examples for both when configuring Magento to use memcache. diff --git a/_includes/config/redis-verify.md b/_includes/config/redis-verify.md index b9f7df55d10..adc959345c4 100644 --- a/_includes/config/redis-verify.md +++ b/_includes/config/redis-verify.md @@ -4,7 +4,7 @@ To verify that Redis and Magento are working together, use the following command In a command prompt on the server on which Redis is running, enter: - redis-cli monitor + redis-cli monitor Refresh your storefront page and you'll see output similar to the following. @@ -52,7 +52,7 @@ If you use Redis for page caching, you'll see output similar to the following: Enter the following command: - redis-cli ping + redis-cli ping `PONG` should be the response. diff --git a/_includes/config/secure-ws-apache_step1.md b/_includes/config/secure-ws-apache_step1.md index a4dba16bda9..b5576c5b68c 100644 --- a/_includes/config/secure-ws-apache_step1.md +++ b/_includes/config/secure-ws-apache_step1.md @@ -4,33 +4,33 @@ For security reasons, you can locate the password file anywhere except your web First, see if you have the Apache `htpasswd` utility is installed as follows: -1. Enter the following command to determine if `htpasswd` is already installed: +1. Enter the following command to determine if `htpasswd` is already installed: - which htpasswd + which htpasswd - If a path displays, it is installed; if the command returns no output, `htpasswd` is not installed. -2. If necessary, install `htpasswd`: + If a path displays, it is installed; if the command returns no output, `htpasswd` is not installed. +2. If necessary, install `htpasswd`: - * Ubuntu: `apt-get -y install apache2-utils` - * CentOS: `yum -y install httpd-tools` + * Ubuntu: `apt-get -y install apache2-utils` + * CentOS: `yum -y install httpd-tools` #### Create a password file Enter the following commands as a user with `root` privileges: - mkdir -p /usr/local/apache/password - htpasswd -c /usr/local/apache/password/. + mkdir -p /usr/local/apache/password + htpasswd -c /usr/local/apache/password/. where -* `` can be: +* `` can be: - * Setting up cron: the web server user or another user. + * Setting up cron: the web server user or another user. - In this example, we use the web server user but the choice of user is up to you. - * Setting up Elasticsearch: the user is named `magento_elasticsearch` in this example + In this example, we use the web server user but the choice of user is up to you. + * Setting up Elasticsearch: the user is named `magento_elasticsearch` in this example -* `` must be a hidden file (starts with `.`) and should reflect the name of the user. See the examples later in this section for details. +* `` must be a hidden file (starts with `.`) and should reflect the name of the user. See the examples later in this section for details. Follow the prompts on your screen to create a password for the user. @@ -39,17 +39,17 @@ Follow the prompts on your screen to create a password for the user. **Example 1: cron** You must set up authentication for only one user for cron; in this example, we use the web server user. To create a password file for the web server user, enter the following commands: - mkdir -p /usr/local/apache/password - htpasswd -c /usr/local/apache/password/.htpasswd apache + mkdir -p /usr/local/apache/password + htpasswd -c /usr/local/apache/password/.htpasswd apache **Example 2: Elasticsearch** You must set up authentication for two users: one with access to nginx and one with access to Elasticsearch. To create password files for these users, enter the following commands: - mkdir -p /usr/local/apache/password - htpasswd -c /usr/local/apache/password/.htpasswd_elasticsearch magento_elasticsearch + mkdir -p /usr/local/apache/password + htpasswd -c /usr/local/apache/password/.htpasswd_elasticsearch magento_elasticsearch #### Add additional users To add another user to your password file, enter the following command as a user with `root` privileges: - htpasswd /usr/local/apache/password/.htpasswd + htpasswd /usr/local/apache/password/.htpasswd diff --git a/_includes/config/secure-ws-apache_step2.md b/_includes/config/secure-ws-apache_step2.md index e04a205c5d5..5d376d42aac 100644 --- a/_includes/config/secure-ws-apache_step2.md +++ b/_includes/config/secure-ws-apache_step2.md @@ -2,12 +2,12 @@ You can optionally enable more than one user to securely communicate by adding t To add another user to your password file, enter the following command as a user with `root` privileges: - htpasswd /usr/local/apache/password/ + htpasswd /usr/local/apache/password/ To create an authorized group, create a group file anywhere outside the web server docroot. The group file specifies the name of the group and the users in the group. In this example, the group name is `MagentoGroup`. - vim /usr/local/apache/password/.group + vim /usr/local/apache/password/.group Contents of the file: - MagentoGroup: ... + MagentoGroup: ... diff --git a/_includes/config/setup-cron.md b/_includes/config/setup-cron.md index ad69976a81f..4d4f8c617e8 100644 --- a/_includes/config/setup-cron.md +++ b/_includes/config/setup-cron.md @@ -2,36 +2,36 @@ Magento uses cron for two sets of tasks, and for each, cron can run with a different configuration: -* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. +* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. - You can find the command-line configuration using the command `php --ini`. -* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). + You can find the command-line configuration using the command `php --ini`. +* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). - You can find the web server plug-in configuration using [`phpinfo.php`]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo). + You can find the web server plug-in configuration using [`phpinfo.php`]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo). {:.bs-callout .bs-callout-warning} -* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). -* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. +* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). +* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. #### Find the PHP binary and php.ini path To display the path to your PHP binary, enter - which php + which php A sample result follows: - /usr/bin/php + /usr/bin/php #### Create the cron job To create a cron job for the Magento file system owner, enter the following command as a user with `root` privileges: - crontab -u -e + crontab -u -e For example, - crontab -u magento_user -e + crontab -u magento_user -e A text editor displays. (You might need to choose a text editor first.) @@ -43,9 +43,9 @@ A text editor displays. (You might need to choose a text editor first.) where -* `` is the absolute file system path to your PHP binary -* `` is the directory in which you installed the Magento software; for example, `/var/www` -* `| grep -v "Ran jobs by schedule"` filters this message from the log, making any errors easier to spot +* `` is the absolute file system path to your PHP binary +* `` is the directory in which you installed the Magento software; for example, `/var/www` +* `| grep -v "Ran jobs by schedule"` filters this message from the log, making any errors easier to spot The first command (`magento cron:run`) reindexes indexers, sends automated e-mails, generates the sitemap, and so on. Usually it's associated with the PHP command line `.ini` file. The other two commands are used by the Component Manager and System Upgrade. diff --git a/_includes/config/setup-cron_2.2.md b/_includes/config/setup-cron_2.2.md index 10150692877..5adc9d1e9cc 100644 --- a/_includes/config/setup-cron_2.2.md +++ b/_includes/config/setup-cron_2.2.md @@ -4,13 +4,13 @@ The Magento _crontab_ is the configuration used to run Magento cron jobs. Magento uses cron for two sets of tasks, and for each, cron can run with a different configuration: -* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. +* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. -* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). +* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). {:.bs-callout .bs-callout-warning} -* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). -* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. +* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). +* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. #### Create the Magento crontab @@ -18,21 +18,21 @@ Starting with version 2.2, Magento creates a crontab for you. We add the Magento To create the Magento crontab, use the following command: - php bin/magento cron:install [--force] + php bin/magento cron:install [--force] Use `--force` to rewrite an existing Magento crontab. (Any existing crontab is not affected.) To view the crontab, switch to the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) and enter the following command: - crontab -l + crontab -l A sample follows: - #~ MAGENTO START - * * * * * /usr/bin/php /var/www/html/magento2/bin/magento cron:run 2>&1 | grep -v Ran jobs by schedule >> /var/www/html/magento2/var/log/magento.cron.log - * * * * * /usr/bin/php /var/www/html/magento2/update/cron.php >> /var/www/html/magento2/var/log/update.cron.log - * * * * * /usr/bin/php /var/www/html/magento2/bin/magento setup:cron:run >> /var/www/html/magento2/var/log/setup.cron.log - #~ MAGENTO END + #~ MAGENTO START + * * * * * /usr/bin/php /var/www/html/magento2/bin/magento cron:run 2>&1 | grep -v Ran jobs by schedule >> /var/www/html/magento2/var/log/magento.cron.log + * * * * * /usr/bin/php /var/www/html/magento2/update/cron.php >> /var/www/html/magento2/var/log/update.cron.log + * * * * * /usr/bin/php /var/www/html/magento2/bin/magento setup:cron:run >> /var/www/html/magento2/var/log/setup.cron.log + #~ MAGENTO END #### Related topic diff --git a/_includes/config/setup-cron_2.2_about.md b/_includes/config/setup-cron_2.2_about.md index 9d13e884e1a..dc3df7c3d7d 100644 --- a/_includes/config/setup-cron_2.2_about.md +++ b/_includes/config/setup-cron_2.2_about.md @@ -4,10 +4,10 @@ The Magento _crontab_ is the configuration used to run Magento cron jobs. Magento uses cron for two sets of tasks, and for each, cron can run with a different configuration: -* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. +* PHP command-line configuration: The general cron job that reindexes indexers, generates e-mails, generates the sitemap, and so on. -* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). +* Web server PHP plug-in configuration: Two other cron jobs are used by the [Component Manager and System Upgrade utilities]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html). {:.bs-callout .bs-callout-warning} -* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). -* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. +* To avoid issues during installation and upgrade, we strongly recommend you apply the same PHP settings to both the PHP command-line configuration and to the PHP web server plug-in's configuration. For more information, see [Required PHP settings]({{ page.baseurl }}/install-gde/prereq/php-settings.html). +* In a multi-node system, crontab can run on only one node. This applies to you only if you set up more than one webnode for reasons related to performance or scalability. diff --git a/_includes/config/setup-cron_2.2_how-to.md b/_includes/config/setup-cron_2.2_how-to.md index 86b24378860..6030581e8ab 100644 --- a/_includes/config/setup-cron_2.2_how-to.md +++ b/_includes/config/setup-cron_2.2_how-to.md @@ -6,26 +6,26 @@ The Magento crontab is inside `#~ MAGENTO START` and `#~ MAGENTO END` comments i To create the Magento crontab: -1. Log in as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). -2. Change to your Magento installation directory. -3. Enter the following command: +1. Log in as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). +2. Change to your Magento installation directory. +3. Enter the following command: - php bin/magento cron:install [--force] + php bin/magento cron:install [--force] Use `--force` to rewrite an existing Magento crontab. {:.bs-callout .bs-callout-info} -* `magento cron:install` does not rewrite an existing crontab inside `#~ MAGENTO START` and `#~ MAGENTO END` comments in your crontab. -* `magento cron:install --force` has no effect on any cron jobs outside the Magento comments. +* `magento cron:install` does not rewrite an existing crontab inside `#~ MAGENTO START` and `#~ MAGENTO END` comments in your crontab. +* `magento cron:install --force` has no effect on any cron jobs outside the Magento comments. To view the crontab, enter the following command as the Magento file system owner: - crontab -l + crontab -l A sample follows: - #~ MAGENTO START - * * * * * /usr/bin/php /var/www/html/magento2/bin/magento cron:run | grep -v Ran jobs by schedule >> /var/www/html/magento2/var/log/magento.cron.log - * * * * * /usr/bin/php /var/www/html/magento2/update/cron.php >> /var/www/html/magento2/var/log/update.cron.log - * * * * * /usr/bin/php /var/www/html/magento2/bin/magento setup:cron:run >> /var/www/html/magento2/var/log/setup.cron.log - #~ MAGENTO END + #~ MAGENTO START + * * * * * /usr/bin/php /var/www/html/magento2/bin/magento cron:run | grep -v Ran jobs by schedule >> /var/www/html/magento2/var/log/magento.cron.log + * * * * * /usr/bin/php /var/www/html/magento2/update/cron.php >> /var/www/html/magento2/var/log/update.cron.log + * * * * * /usr/bin/php /var/www/html/magento2/bin/magento setup:cron:run >> /var/www/html/magento2/var/log/setup.cron.log + #~ MAGENTO END diff --git a/_includes/config/solr-elastic-selinux.md b/_includes/config/solr-elastic-selinux.md index 5b91a84a2a9..76639a52629 100644 --- a/_includes/config/solr-elastic-selinux.md +++ b/_includes/config/solr-elastic-selinux.md @@ -6,7 +6,7 @@ Please take into account that security-related software (iptables, SELinux, AppA To set up rules to allow communication with the firewall or SELinux enabled, consult the following resources: -* [iptables how-to](https://help.ubuntu.com/community/IptablesHowTo) -* [How to edit iptables rules (fedora project)](https://fedoraproject.org/wiki/How_to_edit_iptables_rules) -* [Introduction to SELinux (CentOS.org)](https://www.centos.org) -* [SELinux How-To Wiki (CentOS.org)](https://wiki.centos.org/HowTos/SELinux) +* [iptables how-to](https://help.ubuntu.com/community/IptablesHowTo) +* [How to edit iptables rules (fedora project)](https://fedoraproject.org/wiki/How_to_edit_iptables_rules) +* [Introduction to SELinux (CentOS.org)](https://www.centos.org) +* [SELinux How-To Wiki (CentOS.org)](https://wiki.centos.org/HowTos/SELinux) diff --git a/_includes/config/split-db.md b/_includes/config/split-db.md index f1284798506..a1fc499a5e0 100644 --- a/_includes/config/split-db.md +++ b/_includes/config/split-db.md @@ -2,35 +2,35 @@ Create checkout and OMS master databases as follows: -1. Log in to your database server as any user. -2. Enter the following command to get to a MySQL command prompt: +1. Log in to your database server as any user. +2. Enter the following command to get to a MySQL command prompt: - mysql -u root -p + mysql -u root -p -3. Enter the MySQL `root` user's password when prompted. -4. Enter the following commands in the order shown to create database instances named `magento_quote` and `magento_sales` with the same usernames and passwords: +3. Enter the MySQL `root` user's password when prompted. +4. Enter the following commands in the order shown to create database instances named `magento_quote` and `magento_sales` with the same usernames and passwords: - create database magento_quote; - GRANT ALL ON magento_quote.* TO magento_quote@localhost IDENTIFIED BY 'magento_quote'; + create database magento_quote; + GRANT ALL ON magento_quote.* TO magento_quote@localhost IDENTIFIED BY 'magento_quote'; - create database magento_sales; - GRANT ALL ON magento_sales.* TO magento_sales@localhost IDENTIFIED BY 'magento_sales'; + create database magento_sales; + GRANT ALL ON magento_sales.* TO magento_sales@localhost IDENTIFIED BY 'magento_sales'; -5. Enter `exit` to quit the command prompt. +5. Enter `exit` to quit the command prompt. -6. Verify the databases, one at a time: +6. Verify the databases, one at a time: - Checkout database: + Checkout database: - mysql -u magento_quote -p - exit + mysql -u magento_quote -p + exit - Order management database: + Order management database: - mysql -u magento_sales -p - exit + mysql -u magento_sales -p + exit - If the MySQL monitor displays, you created the database properly. If an error displays, repeat the preceding commands. + If the MySQL monitor displays, you created the database properly. If an error displays, repeat the preceding commands. ## Configure {{site.data.var.ee}} to use the master databases {#config-ee-multidb-master-cli} @@ -44,26 +44,26 @@ After setting up a total of three master databases, use the Magento command line Command syntax: - magento setup:db-schema:split-quote --host="" --dbname="" --username="" --password="" + magento setup:db-schema:split-quote --host="" --dbname="" --username="" --password="" For example, - magento setup:db-schema:split-quote --host="localhost" --dbname="magento_quote" --username="magento_quote" --password="magento_quote" + magento setup:db-schema:split-quote --host="localhost" --dbname="magento_quote" --username="magento_quote" --password="magento_quote" The following message displays to confirm a successful setup: - Migration has been finished successfully! + Migration has been finished successfully! ### Configure the OMS database {#config-ee-multidb-master-cli-oms} Command syntax: - magento setup:db-schema:split-sales --host="" --dbname="" --username="" --password="" + magento setup:db-schema:split-sales --host="" --dbname="" --username="" --password="" For example, - magento setup:db-schema:split-sales --host="localhost" --dbname="magento_sales" --username="magento_sales" --password="magento_sales" + magento setup:db-schema:split-sales --host="localhost" --dbname="magento_sales" --username="magento_sales" --password="magento_sales" The following message displays to confirm a successful setup: - Migration has been finished successfully! + Migration has been finished successfully! diff --git a/_includes/config/split-deploy/config-mgmt-over1.md b/_includes/config/split-deploy/config-mgmt-over1.md index ed5bf2638d1..7ef0952fe69 100644 --- a/_includes/config/split-deploy/config-mgmt-over1.md +++ b/_includes/config/split-deploy/config-mgmt-over1.md @@ -1,14 +1,14 @@ -* _Shared configuration_, which is all settings that are neither system-specific nor sensitive. +* _Shared configuration_, which is all settings that are neither system-specific nor sensitive. - Shared settings are settings you want to be consistent on development and production systems. Set the shared configuration in the Magento Admin in your development (or {{site.data.var.ece}} _integration_) system. + Shared settings are settings you want to be consistent on development and production systems. Set the shared configuration in the Magento Admin in your development (or {{site.data.var.ece}} _integration_) system. - The shared configuration file, `app/etc/config.php`, should be included in source control so it can be shared between development, build, and production systems. + The shared configuration file, `app/etc/config.php`, should be included in source control so it can be shared between development, build, and production systems. -* _System-specific_ configuration, which is all settings that vary by system; for example, search engine hostnames and ports. +* _System-specific_ configuration, which is all settings that vary by system; for example, search engine hostnames and ports. -* _Sensitive_ configuration, which is all settings that should not be in source control because they expose personally-identifiable information (PII) or settings such as API keys or passwords. +* _Sensitive_ configuration, which is all settings that should not be in source control because they expose personally-identifiable information (PII) or settings such as API keys or passwords. - The system-specific configuration file, `app/etc/env.php`, should _not_ be included in source control or otherwise shared between systems. Instead, use the [`magento config:set` and `magento:sensitive:set` commands]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-config-mgmt-set.html) to provide values for those settings in your production system. + The system-specific configuration file, `app/etc/env.php`, should _not_ be included in source control or otherwise shared between systems. Instead, use the [`magento config:set` and `magento:sensitive:set` commands]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-config-mgmt-set.html) to provide values for those settings in your production system. {:.bs-callout .bs-callout-info} These new methods to manage your configuration are optional. You don't have to use them, although we strongly recommend you do. diff --git a/_includes/config/split-deploy/example_build-sync.md b/_includes/config/split-deploy/example_build-sync.md index 2e0c6638b46..dee971ea606 100644 --- a/_includes/config/split-deploy/example_build-sync.md +++ b/_includes/config/split-deploy/example_build-sync.md @@ -1,20 +1,20 @@ To update your build system: -1. Log in to your build system as, or switch to, the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). -2. Change to the build system's Magento root directory. -3. Pull the changes to `app/etc/config.php` from source control. +1. Log in to your build system as, or switch to, the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). +2. Change to the build system's Magento root directory. +3. Pull the changes to `app/etc/config.php` from source control. - The Git command follows: + The Git command follows: - git pull mconfig m2.2_deploy -4. Compile code: + git pull mconfig m2.2_deploy +4. Compile code: - php bin/magento setup:di:compile -5. After code has been compiled, generate static view files: + php bin/magento setup:di:compile +5. After code has been compiled, generate static view files: - php bin/magento setup:static-content:deploy -f -6. Check the changes into source control. + php bin/magento setup:static-content:deploy -f +6. Check the changes into source control. - The Git command follows: + The Git command follows: - git add -A && git commit -m "Updated files on build system" && git push mconfig m2.2_deploy + git add -A && git commit -m "Updated files on build system" && git push mconfig m2.2_deploy diff --git a/_includes/config/split-deploy/example_update-prod.md b/_includes/config/split-deploy/example_update-prod.md index cadee583f75..11fb8f020d6 100644 --- a/_includes/config/split-deploy/example_update-prod.md +++ b/_includes/config/split-deploy/example_update-prod.md @@ -1,24 +1,24 @@ To update the production system: -1. Log in to your production system as, or switch to, the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). -2. Start maintenance mode: +1. Log in to your production system as, or switch to, the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). +2. Start maintenance mode: - cd - php bin/magento maintenance:enable + cd + php bin/magento maintenance:enable - For additional options, such as the ability to set an IP address whitelist, see [`magento maintenance:enable`]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-maint.html). -3. If you use {{site.data.var.ee}}, stop queue workers. TBD -3. Pull code from source control. + For additional options, such as the ability to set an IP address whitelist, see [`magento maintenance:enable`]({{ page.baseurl }}/install-gde/install/cli/install-cli-subcommands-maint.html). +3. If you use {{site.data.var.ee}}, stop queue workers. TBD +3. Pull code from source control. - The Git command follows: + The Git command follows: - git pull mconfig m2.2_deploy -4. Update the configuration: + git pull mconfig m2.2_deploy +4. Update the configuration: - php bin/magento app:config:import -5. Clean the cache: + php bin/magento app:config:import +5. Clean the cache: - php bin/magento cache:clean -4. End maintenance mode: + php bin/magento cache:clean +4. End maintenance mode: - php bin/magento maintenance:disable + php bin/magento maintenance:disable diff --git a/_includes/config/split-deploy/split-deploy-assumptions.md b/_includes/config/split-deploy/split-deploy-assumptions.md index 01049993d88..11083bbc565 100644 --- a/_includes/config/split-deploy/split-deploy-assumptions.md +++ b/_includes/config/split-deploy/split-deploy-assumptions.md @@ -1,8 +1,8 @@ To use pipeline deployment, we assume you are: -* An experienced system integrator with excellent knowledge of Magento configuration options. -* Managing a large Magento site (thousands of stock-keeping units (SKUs)) and want to keep production site downtime to a minimum. -* Somewhat knowledgeable about PHP programming. -* Experienced with source control methods. +* An experienced system integrator with excellent knowledge of Magento configuration options. +* Managing a large Magento site (thousands of stock-keeping units (SKUs)) and want to keep production site downtime to a minimum. +* Somewhat knowledgeable about PHP programming. +* Experienced with source control methods. - To use pipeline deployment, we assume your Magento code is in a source control repository. In this guide, we assume you're using Git but the choice of repositories is up to you. + To use pipeline deployment, we assume your Magento code is in a source control repository. In this guide, we assume you're using Git but the choice of repositories is up to you. diff --git a/_includes/full-width/404-page-header.html b/_includes/full-width/404-page-header.html index 753fbe08793..442395ce352 100644 --- a/_includes/full-width/404-page-header.html +++ b/_includes/full-width/404-page-header.html @@ -1,4 +1,4 @@
-

{{ page.title }}

+

{{ page.title }}

diff --git a/_includes/home/videos.html b/_includes/home/videos.html index 50a22b35bb7..e405bab9924 100644 --- a/_includes/home/videos.html +++ b/_includes/home/videos.html @@ -6,7 +6,7 @@

Video Tutorials

{% assign sorted_videos = (site.videos | where: 'layout', 'video' | sort: 'date') | reverse %} - {% for video in sorted_videos limit:3 %} + {% for video in sorted_videos limit:3 %} {% include video/preview.html %} {% endfor %}
diff --git a/_includes/install/allowoverrides22.md b/_includes/install/allowoverrides22.md index e30ecd77ea0..46bb4c3a80a 100644 --- a/_includes/install/allowoverrides22.md +++ b/_includes/install/allowoverrides22.md @@ -5,35 +5,35 @@ Magento uses server rewrites and `.htaccess` to provide directory-level instruct {:.bs-callout .bs-callout-info} Failure to enable these settings typically results in no styles displaying on your storefront or Admin. -1. Open the following file for editing. +1. Open the following file for editing. - * Ubuntu: `vim /etc/apache2/sites-available/default` - * CentOS: `vim /etc/httpd/conf/httpd.conf` + * Ubuntu: `vim /etc/apache2/sites-available/default` + * CentOS: `vim /etc/httpd/conf/httpd.conf` -2. Locate the block that starts with: +2. Locate the block that starts with: - * Ubuntu 12: `` - * Ubuntu 14 or CentOS: `` + * Ubuntu 12: `` + * Ubuntu 14 or CentOS: `` -3. Change the value of `AllowOverride` to ``. +3. Change the value of `AllowOverride` to ``. - An example for Ubuntu 12 follows. + An example for Ubuntu 12 follows. - - Options Indexes FollowSymLinks MultiViews - AllowOverride - Order allow,deny - Allow from all - + + Options Indexes FollowSymLinks MultiViews + AllowOverride + Order allow,deny + Allow from all + - {:.bs-callout .bs-callout-info} - The preceding values for `Order` might not work in all cases. For more information, see the Apache documentation ([2.2](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order)), [2.4](https://httpd.apache.org/docs/2.4/mod/mod_authz_host.html#order)). + {:.bs-callout .bs-callout-info} + The preceding values for `Order` might not work in all cases. For more information, see the Apache documentation ([2.2](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order)), [2.4](https://httpd.apache.org/docs/2.4/mod/mod_authz_host.html#order)). -4. Save the file and exit the text editor. -5. *Ubuntu only*. Configure Apache to use the `mod_rewrite` module. +4. Save the file and exit the text editor. +5. *Ubuntu only*. Configure Apache to use the `mod_rewrite` module. - cd /etc/apache2/mods-enabled - ln -s ../mods-available/rewrite.load -6. If you changed Apache settings, restart Apache. + cd /etc/apache2/mods-enabled + ln -s ../mods-available/rewrite.load +6. If you changed Apache settings, restart Apache. - service apache2 restart + service apache2 restart diff --git a/_includes/install/allowoverrides24.md b/_includes/install/allowoverrides24.md index 587606f52f9..d63b76a94a6 100644 --- a/_includes/install/allowoverrides24.md +++ b/_includes/install/allowoverrides24.md @@ -19,7 +19,7 @@ Failure to enable these settings typically results in no styles displaying on yo ```terminal - AllowOverride + AllowOverride ``` diff --git a/_includes/install/auth-tokens-get.md b/_includes/install/auth-tokens-get.md index 1b7ce83891c..e13c6130498 100644 --- a/_includes/install/auth-tokens-get.md +++ b/_includes/install/auth-tokens-get.md @@ -7,7 +7,7 @@ To create authentication keys: 3. Click **Access Keys** in the Marketplace tab. - ![Get your secure access keys on Magento Marketplace]({{ site.baseurl }}/common/images/cloud_access-key.png){:width="500px"} + ![Get your secure access keys on Magento Marketplace]({{ site.baseurl }}/common/images/cloud_access-key.png){:width="500px"} 4. Click **Create a New Access Key**. Enter a specific name for the keys (e.g., the name of the developer receiving the keys) and click **OK**. 5. New public and private keys are now associated with your account that you can click to copy. Save this information or keep the page open when working with your Magento project. Use the **Public key** as your username and the **Private key** as your password. @@ -16,15 +16,15 @@ To create authentication keys: You can also disable or delete authentication keys. For example, you can disable or delete keys for security reasons after someone leaves your organization. -* To disable keys: Click **Disable**. You can do this if you want to suspend use of your keys. -* To enable a previously disabled key: Click **Enable**. -* To delete keys: Click **Delete**. +* To disable keys: Click **Disable**. You can do this if you want to suspend use of your keys. +* To enable a previously disabled key: Click **Enable**. +* To delete keys: Click **Delete**. You cannot delete or disable keys you created by signing in to your [magento.com account](https://www.magentocommerce.com/products/customer/account/login){:target="_blank"}. To manage those keys: -1. Log in to your [magento.com account](https://www.magentocommerce.com/products/customer/account/login){:target="_blank"}. -2. Click **My Account** at the top of the page. -3. Click **Account Settings** > **Downloads Access Token**. +1. Log in to your [magento.com account](https://www.magentocommerce.com/products/customer/account/login){:target="_blank"}. +2. Click **My Account** at the top of the page. +3. Click **Account Settings** > **Downloads Access Token**. - ![Access your keys]({{ site.baseurl }}/common/images/connect_keys1.png){:width="200px"} -4. Click **Generate new token** to replace and disable an existing token. + ![Access your keys]({{ site.baseurl }}/common/images/connect_keys1.png){:width="200px"} +4. Click **Generate new token** to replace and disable an existing token. diff --git a/_includes/install/composer-clone.md b/_includes/install/composer-clone.md index 3461ba358e7..bdfa16764ed 100644 --- a/_includes/install/composer-clone.md +++ b/_includes/install/composer-clone.md @@ -11,11 +11,11 @@ If an error displays, use the following steps to install Composer. To install Composer: -1. Change to or create an empty directory on your Magento server. +1. Change to or create an empty directory on your Magento server. -2. Enter the following commands: +2. Enter the following commands: - curl -sS https://getcomposer.org/installer | php - mv composer.phar /usr/local/bin/composer + curl -sS https://getcomposer.org/installer | php + mv composer.phar /usr/local/bin/composer For additional installation options, see the [Composer installation documentation](https://getcomposer.org/download/). diff --git a/_includes/install/file-system-perms-before.md b/_includes/install/file-system-perms-before.md index 407ffd49ae7..beab89b1519 100644 --- a/_includes/install/file-system-perms-before.md +++ b/_includes/install/file-system-perms-before.md @@ -27,9 +27,9 @@ This section discusses how to set ownership and permissions for your own server After you've performed the other tasks in this topic, enter one of the following commands to switch to that user: -* Ubuntu: `su ` -* CentOS: `su - ` +* Ubuntu: `su ` +* CentOS: `su - ` For example, - su magento_user + su magento_user diff --git a/_includes/install/file-system-perms-twouser_cmds-only.md b/_includes/install/file-system-perms-twouser_cmds-only.md index 415b53b5a84..2c30b0ebfdb 100644 --- a/_includes/install/file-system-perms-twouser_cmds-only.md +++ b/_includes/install/file-system-perms-twouser_cmds-only.md @@ -1,7 +1,7 @@ To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2` and the web server group name is `apache`: - cd /var/www/html/magento2 && find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && chown -R :apache . && chmod u+x bin/magento + cd /var/www/html/magento2 && find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && chown -R :apache . && chmod u+x bin/magento In the event file system permissions are set improperly and can't be changed by the Magento file system owner, you can enter the command as a user with `root` privileges: - cd /var/www/html/magento2 && sudo find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && sudo find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && sudo chown -R :apache . && sudo chmod u+x bin/magento + cd /var/www/html/magento2 && sudo find var vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && sudo find var vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && sudo chown -R :apache . && sudo chmod u+x bin/magento diff --git a/_includes/install/file-system-perms-twouser_cmds-only_22.md b/_includes/install/file-system-perms-twouser_cmds-only_22.md index d2c50e11c00..bb6f74fdb52 100644 --- a/_includes/install/file-system-perms-twouser_cmds-only_22.md +++ b/_includes/install/file-system-perms-twouser_cmds-only_22.md @@ -1,7 +1,7 @@ To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2` and the web server group name is `apache`: - cd /var/www/html/magento2 && find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && chown -R :apache . && chmod u+x bin/magento + cd /var/www/html/magento2 && find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && chown -R :apache . && chmod u+x bin/magento In the event file system permissions are set improperly and can't be changed by the Magento file system owner, you can enter the command as a user with `root` privileges: - cd /var/www/html/magento2 && sudo find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && sudo find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && sudo chown -R :apache . && sudo chmod u+x bin/magento + cd /var/www/html/magento2 && sudo find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} + && sudo find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} + && sudo chown -R :apache . && sudo chmod u+x bin/magento diff --git a/_includes/install/file-system-umask-over.md b/_includes/install/file-system-umask-over.md index b0b1284a952..15a5f1f6235 100644 --- a/_includes/install/file-system-umask-over.md +++ b/_includes/install/file-system-umask-over.md @@ -7,8 +7,8 @@ If you're using an Magento version 2.0.5 or earlier, see [Appendix—Magento This topic provides some basic information about our ownership and permissions guidelines. For additional information, see: -* [Set pre-installation ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html) -* [Magento ownership and permissions in development and production]({{ page.baseurl }}/config-guide/prod/prod_file-sys-perms.html) +* [Set pre-installation ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html) +* [Magento ownership and permissions in development and production]({{ page.baseurl }}/config-guide/prod/prod_file-sys-perms.html) ### Magento file system owner @@ -19,23 +19,23 @@ The Magento file system owner is sometimes referred to as the *command-line user The Magento file system owner is any of the following: -* A single user, which is typical of shared hosting. +* A single user, which is typical of shared hosting. - Shared hosting providers enable you to log in to the Magento server as one user. This user can log in, transfer files using FTP, and this user also runs the web server. + Shared hosting providers enable you to log in to the Magento server as one user. This user can log in, transfer files using FTP, and this user also runs the web server. - If you use one Magento user, you have the option of setting a [umask](#restrict) to further restrict access, particularly in production. + If you use one Magento user, you have the option of setting a [umask](#restrict) to further restrict access, particularly in production. -* Users that belong to a shared group, which is typical of private hosting or having your own Magento server. +* Users that belong to a shared group, which is typical of private hosting or having your own Magento server. - In this situation, you typically *cannot* log in to the server as, or switch to, the web server user. Instead, you have separate users: + In this situation, you typically *cannot* log in to the server as, or switch to, the web server user. Instead, you have separate users: - * The web server user, which runs the Magento Admin and storefront. + * The web server user, which runs the Magento Admin and storefront. - * A *command-line user*, which is a local user account you can use to log in to the server. This user runs Magento cron jobs and command-line utilities. + * A *command-line user*, which is a local user account you can use to log in to the server. This user runs Magento cron jobs and command-line utilities. - The web server user and the command-line user might need write permissions to the Magento file system. (The users require write access in [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html) but not in production mode.) You give permissions to both users by way of a shared group to which they both belong. + The web server user and the command-line user might need write permissions to the Magento file system. (The users require write access in [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html) but not in production mode.) You give permissions to both users by way of a shared group to which they both belong. - For private hosting, we recommend you use the default `002` [umask](#restrict); otherwise, the group won't be able to write to the Magento file system. + For private hosting, we recommend you use the default `002` [umask](#restrict); otherwise, the group won't be able to write to the Magento file system. Before you install the Magento software, see [Set pre-installation ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). @@ -50,9 +50,9 @@ Magento uses a three-bit mask, by default `002`, that you subtract from the UNIX Here's what that means: -* 775 for directories, which means full control by the user, full control by the group, and enables everyone to traverse the directory. These permissions are typically required by shared hosting providers. +* 775 for directories, which means full control by the user, full control by the group, and enables everyone to traverse the directory. These permissions are typically required by shared hosting providers. -* 664 for files, which means writable by the user, writable by the group, and read-only for everyone else. +* 664 for files, which means writable by the user, writable by the group, and read-only for everyone else. For more information about `magento_umask`, see [Optionally set a umask]({{ page.baseurl }}/install-gde/install/post-install-umask.html). diff --git a/_includes/install/flow-diagram.md b/_includes/install/flow-diagram.md index 06f5ffab30c..46efd2f8e4b 100644 --- a/_includes/install/flow-diagram.md +++ b/_includes/install/flow-diagram.md @@ -2,30 +2,30 @@ The diagram shows the following: -1. Set up your server environment. +1. Set up your server environment. - Install the prerequisite software, including PHP, Apache, and MySQL. Consult the system requirements for specific information: + Install the prerequisite software, including PHP, Apache, and MySQL. Consult the system requirements for specific information: - * [2.2.x system requirements]({{ site.gdeurl22 }}install-gde/system-requirements-tech.html) - * [2.3.x system requirements]({{ site.gdeurl23 }}install-gde/system-requirements-tech.html) + * [2.2.x system requirements]({{ site.gdeurl22 }}install-gde/system-requirements-tech.html) + * [2.3.x system requirements]({{ site.gdeurl23 }}install-gde/system-requirements-tech.html) -2. Get the Magento software. +2. Get the Magento software. - * For simplicity, get a compressed {{site.data.var.ce}} or {{site.data.var.ee}} [archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html), extract it on your Magento server, and start your installation. + * For simplicity, get a compressed {{site.data.var.ce}} or {{site.data.var.ee}} [archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html), extract it on your Magento server, and start your installation. - * If you are more technical and you are familiar with Composer, get a {{site.data.var.ce}} or {{site.data.var.ee}} {% if page.guide_version == "2.0" %} [metapackage]({{page.baseurl}}/install-gde/prereq/integrator_install.html) {% else %} [metapackage]({{page.baseurl}}/install-gde/composer.html). {% endif %} + * If you are more technical and you are familiar with Composer, get a {{site.data.var.ce}} or {{site.data.var.ee}} {% if page.guide_version == "2.0" %} [metapackage]({{page.baseurl}}/install-gde/prereq/integrator_install.html) {% else %} [metapackage]({{page.baseurl}}/install-gde/composer.html). {% endif %} - * If you want to contribute to the {{site.data.var.ce}} codebase or customize the Magento application, [clone]({{ page.baseurl }}/install-gde/prereq/dev_install.html) the Magento 2 GitHub repository. (This method requires familiarity with both GitHub and Composer.) + * If you want to contribute to the {{site.data.var.ce}} codebase or customize the Magento application, [clone]({{ page.baseurl }}/install-gde/prereq/dev_install.html) the Magento 2 GitHub repository. (This method requires familiarity with both GitHub and Composer.) - {:.bs-callout .bs-callout-info} - To be able to use the Web Setup Wizard to install or upgrade the Magento software, or to manage extensions you get from Magento Marketplace, you must either get a compressed archive or a Composer metapackage. If you clone the GitHub repository, you *cannot* use the Web Setup Wizard to upgrade the Magento software and extensions. You must upgrade using [Composer and Git commands]({{ page.baseurl }}/install-gde/install/cli/dev_options.html). + {:.bs-callout .bs-callout-info} + To be able to use the Web Setup Wizard to install or upgrade the Magento software, or to manage extensions you get from Magento Marketplace, you must either get a compressed archive or a Composer metapackage. If you clone the GitHub repository, you *cannot* use the Web Setup Wizard to upgrade the Magento software and extensions. You must upgrade using [Composer and Git commands]({{ page.baseurl }}/install-gde/install/cli/dev_options.html). -3. Install the Magento software using either the Web Setup Wizard or command line. +3. Install the Magento software using either the Web Setup Wizard or command line. - For simplicity, only the Web Setup Wizard is shown in the diagram. + For simplicity, only the Web Setup Wizard is shown in the diagram. - At each step, the Web Setup Wizard validates the information you entered. As shown in the preceding diagram, if validation fails, you must manually fix the issues before you proceed. + At each step, the Web Setup Wizard validates the information you entered. As shown in the preceding diagram, if validation fails, you must manually fix the issues before you proceed. - If the step fails because prerequisite software isn't set up correctly, review our [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html). + If the step fails because prerequisite software isn't set up correctly, review our [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html). -4. Verify the installation by viewing your storefront and the Magento Admin. +4. Verify the installation by viewing your storefront and the Magento Admin. diff --git a/_includes/install/fully-secure.md b/_includes/install/fully-secure.md index 187dfbc7e3b..c06dc1bb6d9 100644 --- a/_includes/install/fully-secure.md +++ b/_includes/install/fully-secure.md @@ -2,9 +2,9 @@ To use Secure Sockets Layer (SSL), also referred to as HTTPS, for both the Magento Admin and the storefront, you must set all of the following parameters: -* `--use-secure`: Set to `1` -* `--base-url-secure`: Set to a secure URL (that is, starting with `https://`) -* `--use-secure-admin` Set to `1` - +* `--use-secure`: Set to `1` +* `--base-url-secure`: Set to a secure URL (that is, starting with `https://`) +* `--use-secure-admin` Set to `1` + More details about these parameters can be found later in this topic. diff --git a/_includes/install/get-software_zip.md b/_includes/install/get-software_zip.md index a63264fa4f5..3c813cd649e 100644 --- a/_includes/install/get-software_zip.md +++ b/_includes/install/get-software_zip.md @@ -1,42 +1,42 @@ The following table discusses where to get the Magento software. We provide the following downloads: -* {{site.data.var.ce}} or {{site.data.var.ee}} software only -* {{site.data.var.ce}} or {{site.data.var.ee}} software with sample data (designed to help you learn Magento faster) +* {{site.data.var.ce}} or {{site.data.var.ee}} software only +* {{site.data.var.ce}} or {{site.data.var.ee}} software with sample data (designed to help you learn Magento faster) These packages are easy to get and install. You don't need to use Composer, all you need to do is to upload a package to your Magento server or hosted platform, unpack it, and run the web-based Setup Wizard. Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz` - - + + - - + + - - + + - - + + +
  • Transfer the installation package to your development system.
    • Magento editionInstall package locationMagento editionInstall package location
    {{site.data.var.ce}}

    www.magento.com/download

    -

    Choose either the software or the software and sample data:

    -
    • Magento-CE-<version>.* (without sample data)
      • -
    • Magento-CE-<version>+Samples.* (with sample data)
      • -

      <version/> is the three-digit release number (for example, 2.0.7, 2.1.0, and so on.)

    		{{site.data.var.ce}}

    www.magento.com/download

    +

    Choose either the software or the software and sample data:

    +
    • Magento-CE-<version>.* (without sample data)
      • +
    • Magento-CE-<version>+Samples.* (with sample data)
      • +

      <version/> is the three-digit release number (for example, 2.0.7, 2.1.0, and so on.)
    {{site.data.var.ee}}Use the following steps: -
    1. Go to www.magento.com
      2. -
    2. In the top horizontal navigation bar, click My Account.
      3. -
    3. Log in with your Magento username and password.
      4. -
    4. In the left navigation bar, click Downloads.
      5. -
    5. In the right pane, click Magento Enterprise Edition 2.X > Full Release or Magento Enterprise Edition 2.X > Full Release + Sample Data for the software.
      6. -
    6. Follow the instructions on your screen to complete the {{site.data.var.ee}} download: -
      • Magento-EE-<version>.* (without sample data)
        • -
      • Magento-EE-<version>+Samples.* (with sample data)
      +
    		{{site.data.var.ee}}Use the following steps: +
    1. Go to www.magento.com
      2. +
    2. In the top horizontal navigation bar, click My Account.
      3. +
    3. Log in with your Magento username and password.
      4. +
    4. In the left navigation bar, click Downloads.
      5. +
    5. In the right pane, click Magento Enterprise Edition 2.X > Full Release or Magento Enterprise Edition 2.X > Full Release + Sample Data for the software.
      6. +
    6. Follow the instructions on your screen to complete the {{site.data.var.ee}} download: +
      • Magento-EE-<version>.* (without sample data)
        • +
      • Magento-EE-<version>+Samples.* (with sample data)
      -
      7. -
    7. Transfer the installation package to your development system.
    diff --git a/_includes/install/install-roadmap.md b/_includes/install/install-roadmap.md index d0e2b571740..2dc0f852054 100644 --- a/_includes/install/install-roadmap.md +++ b/_includes/install/install-roadmap.md @@ -10,34 +10,34 @@ Do you know what a "terminal" application is? Do you know what operating system Topics include: -* [Choose how to get the Magento software]({{ page.baseurl }}/install-gde/bk-install-guide.html) -* [System requirements]({{ page.baseurl }}/install-gde/system-requirements.html) -* [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html) -* [The Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) +* [Choose how to get the Magento software]({{ page.baseurl }}/install-gde/bk-install-guide.html) +* [System requirements]({{ page.baseurl }}/install-gde/system-requirements.html) +* [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html) +* [The Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html) ## Installation part 2: Installing Topics include: -* [Command line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) -* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html) -* [Optional sample data]({{ page.baseurl }}/install-gde/install/web/install-web-sample-data.html) +* [Command line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) +* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html) +* [Optional sample data]({{ page.baseurl }}/install-gde/install/web/install-web-sample-data.html) ## Installation part 3: Post-installation Topics include: -* [Verifying]({{ page.baseurl }}/install-gde/install/verify.html) -* [Configuring]({{ page.baseurl }}/install-gde/install/post-install-config.html) -* [Optional sample data (after installing Magento)]({{ page.baseurl }}/install-gde/install/sample-data-after-magento.html) +* [Verifying]({{ page.baseurl }}/install-gde/install/verify.html) +* [Configuring]({{ page.baseurl }}/install-gde/install/post-install-config.html) +* [Optional sample data (after installing Magento)]({{ page.baseurl }}/install-gde/install/sample-data-after-magento.html) ## Upgrade, update Topics include: -* [Upgrading (or *patching* the Magento application)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html) -* [Updating components (including install, uninstall, update, enable, disable)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html) -* *Contributing developers only*: [Contributing developers—update, reinstall Magento]({{ page.baseurl }}/install-gde/install/cli/dev_options.html) +* [Upgrading (or *patching* the Magento application)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html) +* [Updating components (including install, uninstall, update, enable, disable)]({{ page.baseurl }}/comp-mgr/bk-compman-upgrade-guide.html) +* *Contributing developers only*: [Contributing developers—update, reinstall Magento]({{ page.baseurl }}/install-gde/install/cli/dev_options.html) ## Deploy to production diff --git a/_includes/install/mysql_max-allowed-packet-centos.md b/_includes/install/mysql_max-allowed-packet-centos.md index 00797675e52..120fd61ed3d 100644 --- a/_includes/install/mysql_max-allowed-packet-centos.md +++ b/_includes/install/mysql_max-allowed-packet-centos.md @@ -1,9 +1,9 @@ - To increase the value, open `/etc/mysql.cnf` in a text editor and add search for `max_allowed_packet`. Set the value to `16M` or larger. + To increase the value, open `/etc/mysql.cnf` in a text editor and add search for `max_allowed_packet`. Set the value to `16M` or larger. - If it does not exist, add it before `[mysqld_safe]`. + If it does not exist, add it before `[mysqld_safe]`. - Save your changes to `mysql.cnf`, close the text editor, and restart MySQL (`service mysqld restart`). + Save your changes to `mysql.cnf`, close the text editor, and restart MySQL (`service mysqld restart`). - To optionally verify the value you set, enter the following command at a `mysql>` prompt: + To optionally verify the value you set, enter the following command at a `mysql>` prompt: - SHOW VARIABLES LIKE 'max_allowed_packet'; + SHOW VARIABLES LIKE 'max_allowed_packet'; diff --git a/_includes/install/mysql_max-allowed-packet-ubuntu.md b/_includes/install/mysql_max-allowed-packet-ubuntu.md index 5d755b7af67..f824797f23c 100644 --- a/_includes/install/mysql_max-allowed-packet-ubuntu.md +++ b/_includes/install/mysql_max-allowed-packet-ubuntu.md @@ -1,5 +1,5 @@ - To increase the value, open `/etc/mysql/mysql.cnf` in a text editor and locate the value for `max_allowed_packet`. Save your changes to `mysql.cnf`, close the text editor, and restart MySQL (`service mysql restart`). + To increase the value, open `/etc/mysql/mysql.cnf` in a text editor and locate the value for `max_allowed_packet`. Save your changes to `mysql.cnf`, close the text editor, and restart MySQL (`service mysql restart`). - To optionally verify the value you set, enter the following command at a `mysql>` prompt: + To optionally verify the value you set, enter the following command at a `mysql>` prompt: - SHOW VARIABLES LIKE 'max_allowed_packet'; + SHOW VARIABLES LIKE 'max_allowed_packet'; diff --git a/_includes/install/patch/get-patch.md b/_includes/install/patch/get-patch.md index 8fe7621aae9..19f8cebc16e 100644 --- a/_includes/install/patch/get-patch.md +++ b/_includes/install/patch/get-patch.md @@ -1,36 +1,36 @@ - - - - - - - - - - - + + + + + + + + + + - - - - - + +
  • Transfer the patch to your development system.
    • + + + + +
    Magento editionPatch location
    {{site.data.var.ce}}

    www.magento.com/download

    -

    Follow the instructions on your screen to download the desired patch.

    {{site.data.var.ee}} merchant portalUse the following steps: -
    1. Go to www.magento.com
      2. -
    2. In the top horizontal navigation bar, click My Account.
      3. -
    3. Log in with your Magento username and password.
      4. -
    4. In the left navigation bar, click Downloads.
      5. -
    5. Click Magento Enterprise Edition 2.X > Magento Enterprise Edition 2.x Release > Support Patches
      6. -
    6. Follow the instructions on your screen to download the desired patch.
      7. +
    Magento editionPatch location
    {{site.data.var.ce}}

    www.magento.com/download

    +

    Follow the instructions on your screen to download the desired patch.

    {{site.data.var.ee}} merchant portalUse the following steps: +
    1. Go to www.magento.com
      2. +
    2. In the top horizontal navigation bar, click My Account.
      3. +
    3. Log in with your Magento username and password.
      4. +
    4. In the left navigation bar, click Downloads.
      5. +
    5. Click Magento Enterprise Edition 2.X > Magento Enterprise Edition 2.x Release > Support Patches
      6. +
    6. Follow the instructions on your screen to download the desired patch.
      7. - -
    7. Transfer the patch to your development system.
    Magento EE partner portalUse the following steps: -
    1. Log in to partners.magento.com
      2. -
    2. Click Magento Enterprise Edition > Magento Enterprise Edition 2.X > Magento Enterprise Edition 2.x Release > Support Patches.
      3. -
    3. In the left navigation bar, click Downloads.
      4. -
    4. Follow the instructions on your screen to download the desired patch.
      5. -
    5. Transfer the patch to your development system.
    Magento EE partner portalUse the following steps: +
    1. Log in to partners.magento.com
      2. +
    2. Click Magento Enterprise Edition > Magento Enterprise Edition 2.X > Magento Enterprise Edition 2.x Release > Support Patches.
      3. +
    3. In the left navigation bar, click Downloads.
      4. +
    4. Follow the instructions on your screen to download the desired patch.
      5. +
    5. Transfer the patch to your development system.
    diff --git a/_includes/install/paypal-tls1-2.md b/_includes/install/paypal-tls1-2.md index dac80875716..50318c4746f 100644 --- a/_includes/install/paypal-tls1-2.md +++ b/_includes/install/paypal-tls1-2.md @@ -4,29 +4,29 @@ PayPal recently announced they will require Transport Layer Security (TLS) versi More information: -* [Details (PayPal security bulletin)](https://www.paypal.com/uk/webapps/mpp/ssl-security-update) -* [PayPal live payments switching in June 2016 (PayPal technical blog)](https://devblog.paypal.com/upcoming-security-changes-notice/#tls) +* [Details (PayPal security bulletin)](https://www.paypal.com/uk/webapps/mpp/ssl-security-update) +* [PayPal live payments switching in June 2016 (PayPal technical blog)](https://devblog.paypal.com/upcoming-security-changes-notice/#tls) ### Symptom According to PayPal, symptoms of the issue include the following messages in your error log: - *Unknown SSL protocol error* in connection to api-3t.sandbox.paypal.com:-9824 + *Unknown SSL protocol error* in connection to api-3t.sandbox.paypal.com:-9824 or - 140062736746144:error:1408F10B:SSL routines:SSL3_GET_RECORD:wrong version number:s3_pkt.c:337: + 140062736746144:error:1408F10B:SSL routines:SSL3_GET_RECORD:wrong version number:s3_pkt.c:337: - ... (more messages) ... + ... (more messages) ... - New, (NONE), Cipher is (NONE) - Secure Renegotiation IS NOT supported* - Compression: NONE - Expansion: NONE - SSL-Session: - Protocol: SSLv3* + New, (NONE), Cipher is (NONE) + Secure Renegotiation IS NOT supported* + Compression: NONE + Expansion: NONE + SSL-Session: + Protocol: SSLv3* - ... (more messages) ... + ... (more messages) ... ### Description @@ -34,7 +34,7 @@ The source of the issue is your version of [`libcurl`](https://curl.haxx.se/libc To determine the version of `libcurl` you're running, enter the following command on the server that processes PayPal transactions: - curl --version + curl --version If the version is earlier than 7.34, continue with the next section. If you're already running version 7.34 or later, no action is necessary. @@ -44,7 +44,7 @@ The source of the issue is that the [`libcurl`](https://curl.haxx.se/libcurl/c/C To determine the version of CentOS your server runs, enter the following command: - cat /etc/*release* + cat /etc/*release* If you're already running CentOS 6.8 or later, no action is necessary. According to the [CentOS 6.8 changelog](https://wiki.centos.org/Manuals/ReleaseNotes/CentOS6.8), "various applications now support TLS 1.2, i.e. OpenLDAP, yum, stunnel, vsftpd, git, postfix and others. Also TLS 1.2 has been enabled by default in various packages". @@ -52,15 +52,15 @@ If you're already running CentOS 6.8 or later, no action is necessary. According You have the following options: -* (Recommended). Upgrade your Magento server to CentOS 6.8 or later. +* (Recommended). Upgrade your Magento server to CentOS 6.8 or later. - Its recommended repositories support current versions of TLS with `libcurl`. Using CentOS 6.8 or later is the most secure way to continue operating your store and accepting PayPal. + Its recommended repositories support current versions of TLS with `libcurl`. Using CentOS 6.8 or later is the most secure way to continue operating your store and accepting PayPal. - CentOS 6.8 has a `libcurl` version that defaults to TLS 1.2. + CentOS 6.8 has a `libcurl` version that defaults to TLS 1.2. -* (Less secure, *not recommended*). Upgrade to `libcurl` 7.34 or later on CentOS 6 using a non-recommended third-party repository. +* (Less secure, *not recommended*). Upgrade to `libcurl` 7.34 or later on CentOS 6 using a non-recommended third-party repository. - One possible solution is to use the information on [serverfault](http://serverfault.com/questions/321321/upgrade-curl-to-latest-on-centos). + One possible solution is to use the information on [serverfault](http://serverfault.com/questions/321321/upgrade-curl-to-latest-on-centos). {:.bs-callout .bs-callout-info} Installing software from non-recommended repositories can change other system packages and can result in issues. We strongly recommend you upgrade `libcurl` in a development environment and *thoroughly test* all payment processors you use as well as any other critical software before putting this into production. diff --git a/_includes/install/releasenotes/20_release-notes-links.md b/_includes/install/releasenotes/20_release-notes-links.md index b3980b6a5e4..88211cf5e55 100644 --- a/_includes/install/releasenotes/20_release-notes-links.md +++ b/_includes/install/releasenotes/20_release-notes-links.md @@ -1,58 +1,58 @@ {% collapsibleh2 Magento Open Source 2.0 Release Notes %} -* [Version 2.0.18]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.18CE.html){:target="_blank"} -* [Version 2.0.17]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.17CE.html){:target="_blank"} -* [Version 2.0.16]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.16CE.html){:target="_blank"} -* [Version 2.0.15]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.15CE.html){:target="_blank"} -* [Version 2.0.14]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.14CE.html){:target="_blank"} -* [Version 2.0.13]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.13CE.html){:target="_blank"} -* [Version 2.0.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.12CE.html){:target="_blank"} -* [Version 2.0.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.11CE.html){:target="_blank"} -* [Version 2.0.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.10CE.html){:target="_blank"} -* [Version 2.0.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.9CE.html){:target="_blank"} -* [Version 2.0.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.8CE.html){:target="_blank"} -* [Version 2.0.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.7CE.html){:target="_blank"} -* [Version 2.0.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.6CE.html){:target="_blank"} -* [Version 2.0.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.5CE.html){:target="_blank"} -* [Version 2.0.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.4CE.html){:target="_blank"} -* [Version 2.0.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.3CE.html){:target="_blank"} -* [Version 2.0.2](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.2.html){:target="_blank"} -* [Version 2.0.1](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.1.html){:target="_blank"} -* [Version 2.0.0](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.html){:target="_blank"} +* [Version 2.0.18]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.18CE.html){:target="_blank"} +* [Version 2.0.17]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.17CE.html){:target="_blank"} +* [Version 2.0.16]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.16CE.html){:target="_blank"} +* [Version 2.0.15]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.15CE.html){:target="_blank"} +* [Version 2.0.14]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.14CE.html){:target="_blank"} +* [Version 2.0.13]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.13CE.html){:target="_blank"} +* [Version 2.0.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.12CE.html){:target="_blank"} +* [Version 2.0.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.11CE.html){:target="_blank"} +* [Version 2.0.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.10CE.html){:target="_blank"} +* [Version 2.0.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.9CE.html){:target="_blank"} +* [Version 2.0.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.8CE.html){:target="_blank"} +* [Version 2.0.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.7CE.html){:target="_blank"} +* [Version 2.0.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.6CE.html){:target="_blank"} +* [Version 2.0.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.5CE.html){:target="_blank"} +* [Version 2.0.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.4CE.html){:target="_blank"} +* [Version 2.0.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.3CE.html){:target="_blank"} +* [Version 2.0.2](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.2.html){:target="_blank"} +* [Version 2.0.1](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.1.html){:target="_blank"} +* [Version 2.0.0](http://docs.magento.com/m2/ce/user_guide/magento/release-notes-ce-2.0.html){:target="_blank"} {% endcollapsibleh2 %} {% collapsibleh2 Magento Commerce 2.0 Release Notes %} -* [Version 2.0.18]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.18EE.html){:target="_blank"} -* [Version 2.0.17]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.17EE.html){:target="_blank"} -* [Version 2.0.16]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.16EE.html){:target="_blank"} -* [Version 2.0.15]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.15EE.html){:target="_blank"} -* [Version 2.0.14]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.14EE.html){:target="_blank"} -* [Version 2.0.13]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.13EE.html){:target="_blank"} -* [Version 2.0.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.12EE.html){:target="_blank"} -* [Version 2.0.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.11EE.html){:target="_blank"} -* [Version 2.0.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.10EE.html){:target="_blank"} -* [Version 2.0.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.9EE.html){:target="_blank"} -* [Version 2.0.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.8EE.html){:target="_blank"} -* [Version 2.0.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.7EE.html){:target="_blank"} -* [Version 2.0.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.6EE.html){:target="_blank"} -* [Version 2.0.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.5EE.html){:target="_blank"} -* [Version 2.0.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.4EE.html){:target="_blank"} -* [Version 2.0.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.3EE.html){:target="_blank"} -* [Version 2.0.2](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.2.html){:target="_blank"} -* [Version 2.0.1](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.1.html){:target="_blank"} -* [Version 2.0.0](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.html){:target="_blank"} +* [Version 2.0.18]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.18EE.html){:target="_blank"} +* [Version 2.0.17]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.17EE.html){:target="_blank"} +* [Version 2.0.16]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.16EE.html){:target="_blank"} +* [Version 2.0.15]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.15EE.html){:target="_blank"} +* [Version 2.0.14]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.14EE.html){:target="_blank"} +* [Version 2.0.13]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.13EE.html){:target="_blank"} +* [Version 2.0.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.12EE.html){:target="_blank"} +* [Version 2.0.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.11EE.html){:target="_blank"} +* [Version 2.0.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.10EE.html){:target="_blank"} +* [Version 2.0.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.9EE.html){:target="_blank"} +* [Version 2.0.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.8EE.html){:target="_blank"} +* [Version 2.0.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.7EE.html){:target="_blank"} +* [Version 2.0.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.6EE.html){:target="_blank"} +* [Version 2.0.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.5EE.html){:target="_blank"} +* [Version 2.0.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.4EE.html){:target="_blank"} +* [Version 2.0.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.0.3EE.html){:target="_blank"} +* [Version 2.0.2](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.2.html){:target="_blank"} +* [Version 2.0.1](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.1.html){:target="_blank"} +* [Version 2.0.0](http://docs.magento.com/m2/ee/user_guide/magento/release-notes-ee-2.0.html){:target="_blank"} {% endcollapsibleh2 %} {% collapsibleh2 Magento Commerce (Cloud) 2.0 Release Notes %} -* [Magento Commerce (Cloud) version 2.1.5 and 2.0.13 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.5.html){:target="_blank"} -* [magento-cloud-configuration release 101.4.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.4.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.4 and 2.0.12]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.4.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.3 and 2.0.11]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.3.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.2 and 2.0.10]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.2.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.5 and 2.0.13 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.5.html){:target="_blank"} +* [magento-cloud-configuration release 101.4.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.4.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.4 and 2.0.12]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.4.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.3 and 2.0.11]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.3.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.2 and 2.0.10]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.2.html){:target="_blank"} {% endcollapsibleh2 %} diff --git a/_includes/install/releasenotes/20rc_release-notes-links.md b/_includes/install/releasenotes/20rc_release-notes-links.md index a1b09435c2f..1369a92acc3 100644 --- a/_includes/install/releasenotes/20rc_release-notes-links.md +++ b/_includes/install/releasenotes/20rc_release-notes-links.md @@ -1,16 +1,16 @@ {% collapsibleh3 Magento Open Source 2.1 Release Candidate Notes %} -* [Open Source 2.1 Release Candidate 3 (RC3)]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC3EE.html){:target="_blank"} -* [Open Source 2.1 RC2)]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC2EE.html){:target="_blank"} -* [Open Source 2.1 RC1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC1EE.html){:target="_blank"} +* [Open Source 2.1 Release Candidate 3 (RC3)]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC3EE.html){:target="_blank"} +* [Open Source 2.1 RC2)]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC2EE.html){:target="_blank"} +* [Open Source 2.1 RC1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC1EE.html){:target="_blank"} {% endcollapsibleh3 %} {% collapsibleh3 Magento Commerce 2.1 Release Candidate Notes %} -* [Commerce 2.1 RC3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC3CE.html){:target="_blank"} -* [Commerce 2.1 RC2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC2CE.html){:target="_blank"} -* [Commerce 2.1 RC1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC1CE.html){:target="_blank"} +* [Commerce 2.1 RC3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC3CE.html){:target="_blank"} +* [Commerce 2.1 RC2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC2CE.html){:target="_blank"} +* [Commerce 2.1 RC1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1_RC1CE.html){:target="_blank"} {% endcollapsibleh3 %} \ No newline at end of file diff --git a/_includes/install/releasenotes/21_release-notes-links.md b/_includes/install/releasenotes/21_release-notes-links.md index 29ea60379a6..422b22b71c7 100644 --- a/_includes/install/releasenotes/21_release-notes-links.md +++ b/_includes/install/releasenotes/21_release-notes-links.md @@ -1,50 +1,50 @@ {% collapsibleh2 Magento Open Source 2.1 Release Notes %} -* [Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12CE.html){:target="_blank"} -* [Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11CE.html){:target="_blank"} -* [Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10CE.html){:target="_blank"} -* [Version 2.1.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.9CE.html){:target="_blank"} -* [Version 2.1.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.8CE.html){:target="_blank"} -* [Version 2.1.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.7CE.html){:target="_blank"} -* [Version 2.1.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.6CE.html){:target="_blank"} -* [Version 2.1.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.5CE.html){:target="_blank"} -* [Version 2.1.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.4CE.html){:target="_blank"} -* [Version 2.1.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.3CE.html){:target="_blank"} -* [Version 2.1.2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.2CE.html){:target="_blank"} -* [Version 2.1.1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.1CE.html){:target="_blank"} -* [Version 2.1.0]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.0CE.html){:target="_blank"} +* [Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12CE.html){:target="_blank"} +* [Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11CE.html){:target="_blank"} +* [Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10CE.html){:target="_blank"} +* [Version 2.1.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.9CE.html){:target="_blank"} +* [Version 2.1.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.8CE.html){:target="_blank"} +* [Version 2.1.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.7CE.html){:target="_blank"} +* [Version 2.1.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.6CE.html){:target="_blank"} +* [Version 2.1.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.5CE.html){:target="_blank"} +* [Version 2.1.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.4CE.html){:target="_blank"} +* [Version 2.1.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.3CE.html){:target="_blank"} +* [Version 2.1.2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.2CE.html){:target="_blank"} +* [Version 2.1.1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.1CE.html){:target="_blank"} +* [Version 2.1.0]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.0CE.html){:target="_blank"} {% endcollapsibleh2 %} {% collapsibleh2 Magento Commerce 2.1 Release Notes %} -* [Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12EE.html){:target="_blank"} -* [Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11EE.html){:target="_blank"} -* [Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10EE.html){:target="_blank"} -* [Version 2.1.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.9EE.html){:target="_blank"} -* [Version 2.1.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.8EE.html){:target="_blank"} -* [Version 2.1.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.7EE.html){:target="_blank"} -* [Version 2.1.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.6EE.html){:target="_blank"} -* [Version 2.1.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.5EE.html){:target="_blank"} -* [Version 2.1.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.4EE.html){:target="_blank"} -* [Version 2.1.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.3EE.html){:target="_blank"} -* [Version 2.1.2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.2EE.html){:target="_blank"} -* [Version 2.1.1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.1EE.html){:target="_blank"} -* [Version 2.1.0]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.0EE.html){:target="_blank"} +* [Version 2.1.12]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.12EE.html){:target="_blank"} +* [Version 2.1.11]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.11EE.html){:target="_blank"} +* [Version 2.1.10]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.10EE.html){:target="_blank"} +* [Version 2.1.9]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.9EE.html){:target="_blank"} +* [Version 2.1.8]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.8EE.html){:target="_blank"} +* [Version 2.1.7]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.7EE.html){:target="_blank"} +* [Version 2.1.6]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.6EE.html){:target="_blank"} +* [Version 2.1.5]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.5EE.html){:target="_blank"} +* [Version 2.1.4]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.4EE.html){:target="_blank"} +* [Version 2.1.3]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.3EE.html){:target="_blank"} +* [Version 2.1.2]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.2EE.html){:target="_blank"} +* [Version 2.1.1]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.1EE.html){:target="_blank"} +* [Version 2.1.0]({{ page.baseurl }}/release-notes/ReleaseNotes2.1.0EE.html){:target="_blank"} {% endcollapsibleh2 %} {% collapsibleh2 Magento Commerce (Cloud) 2.1 Release Notes %} -* [magento-cloud-configuration release 101.9.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.9.html){:target="_blank"} -* [magento-cloud-configuration release 101.8.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.8.html){:target="_blank"} -* [magento-cloud-configuration release 101.7.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.7.html){:target="_blank"} -* [magento-cloud-configuration release 101.6.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.6.html){:target="_blank"} -* [magento-cloud-configuration release 101.5.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.5.html){:target="_blank"} -* [magento-cloud-configuration release 101.4.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.4.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.6 through 2.1.11 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.6-2.1.11.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.5 and 2.0.13 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.5.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.4 and 2.0.12]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.4.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.3 and 2.0.11]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.3.html){:target="_blank"} -* [Magento Commerce (Cloud) version 2.1.2 and 2.0.10]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.2.html){:target="_blank"} +* [magento-cloud-configuration release 101.9.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.9.html){:target="_blank"} +* [magento-cloud-configuration release 101.8.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.8.html){:target="_blank"} +* [magento-cloud-configuration release 101.7.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.7.html){:target="_blank"} +* [magento-cloud-configuration release 101.6.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.6.html){:target="_blank"} +* [magento-cloud-configuration release 101.5.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.5.html){:target="_blank"} +* [magento-cloud-configuration release 101.4.x Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes101.4.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.6 through 2.1.11 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.6-2.1.11.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.5 and 2.0.13 Release Notes]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.5.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.4 and 2.0.12]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.4.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.3 and 2.0.11]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.3.html){:target="_blank"} +* [Magento Commerce (Cloud) version 2.1.2 and 2.0.10]({{ page.baseurl }}/cloud/release-notes/CloudReleaseNotes2.1.2.html){:target="_blank"} {% endcollapsibleh2 %} diff --git a/_includes/install/releasenotes/ce_install_20.md b/_includes/install/releasenotes/ce_install_20.md index b41c0de7df7..725057d2fb8 100644 --- a/_includes/install/releasenotes/ce_install_20.md +++ b/_includes/install/releasenotes/ce_install_20.md @@ -3,22 +3,22 @@ See one of the following sections: -* [Get Magento Open Source using Composer](#install-ce-composer) -* [Get Magento Open Source using a compressed archive](#get-zip) -* [Complete the installation](#install-complete) +* [Get Magento Open Source using Composer](#install-ce-composer) +* [Get Magento Open Source using a compressed archive](#get-zip) +* [Complete the installation](#install-complete) ### Get the Magento Open Source software using Composer {#install-ce-composer} {:.no_toc} This software is available from `repo.magento.com`. Before installing the Open Source software using Composer, familiarize yourself with the Composer [metapackage]({{page.baseurl}}/install-gde/prereq/integrator_install.html), then run: - composer create-project --repository=https://repo.magento.com/ magento/project-community-edition= + composer create-project --repository=https://repo.magento.com/ magento/project-community-edition= where `` matches the version you want (for example, `2.0.10`) For example, to install {{site.data.var.ce}} 2.0.10 in the `magento2` directory: - composer create-project --repository=https://repo.magento.com/ magento/project-community-edition=2.0.10 magento2 + composer create-project --repository=https://repo.magento.com/ magento/project-community-edition=2.0.10 magento2 ### Get Magento Open Source using a compressed archive {#get-zip} {:.no_toc} @@ -30,15 +30,15 @@ For example, to install {{site.data.var.ce}} 2.0.10 in the `magento2` directory: After you get the Open Source software: -1. [Set file system ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). -2. Install the Magento software: +1. [Set file system ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). +2. Install the Magento software: - * [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html) - * [Command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) + * [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html) + * [Command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) ## Upgrade from an earlier version {#upgrade} To upgrade to version 2.0.x from an earlier version: -* [Web Setup Wizard (System Upgrade)]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) -* [Command-line upgrade]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html) +* [Web Setup Wizard (System Upgrade)]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) +* [Command-line upgrade]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html) diff --git a/_includes/install/releasenotes/ee_install_20.md b/_includes/install/releasenotes/ee_install_20.md index 76d00821de4..2ba3cff13f3 100644 --- a/_includes/install/releasenotes/ee_install_20.md +++ b/_includes/install/releasenotes/ee_install_20.md @@ -3,22 +3,22 @@ See one of the following sections: -* [Get Magento Commerce using Composer](#install-rc-composer) -* [Get Magento Commerce using a compressed archive](#get-zip) -* [Complete the installation](#install-complete) +* [Get Magento Commerce using Composer](#install-rc-composer) +* [Get Magento Commerce using a compressed archive](#get-zip) +* [Complete the installation](#install-complete) ### Get Magento Commerce using Composer {#install-rc-composer} {:.no_toc} This software is available from `repo.magento.com`. Before installing the Magento Commerce software using Composer, familiarize yourself with the Composer [metapackage]({{page.baseurl}}/install-gde/prereq/integrator_install.html), then run: - composer create-project --repository=https://repo.magento.com/ magento/project-enterprise-edition= + composer create-project --repository=https://repo.magento.com/ magento/project-enterprise-edition= where `` matches the version you want (for example, `2.0.10`) For example, to install 2.0.10 in the `magento2` directory: - composer create-project --repository=https://repo.magento.com/ magento/project-enterprise-edition=2.0.10 magento2 + composer create-project --repository=https://repo.magento.com/ magento/project-enterprise-edition=2.0.10 magento2 ### Get Magento Commerce using a compressed archive {#get-zip} {:.no_toc} @@ -30,15 +30,15 @@ For example, to install 2.0.10 in the `magento2` directory: After you get the Commerce software: -1. [Set file system ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). -2. Install the Magento software: +1. [Set file system ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). +2. Install the Magento software: - * [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html) - * [Command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) + * [Web Setup Wizard]({{ page.baseurl }}/install-gde/install/web/install-web.html) + * [Command line]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) ## Upgrade from an earlier version {#upgrade} To upgrade to version 2.0.x from an earlier version: -* [Web Setup Wizard (System Upgrade)]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) -* [Command-line upgrade]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html) +* [Web Setup Wizard (System Upgrade)]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) +* [Command-line upgrade]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html) diff --git a/_includes/install/releasenotes/get-ce-software_zip.md b/_includes/install/releasenotes/get-ce-software_zip.md index 9d8370d116e..34745d1d0bf 100644 --- a/_includes/install/releasenotes/get-ce-software_zip.md +++ b/_includes/install/releasenotes/get-ce-software_zip.md @@ -1,8 +1,8 @@ The following table discusses where to get the Magento software. We provide the following downloads: -* Magento Open Source software only -* Magento Open Source software with sample data (designed to help you learn Magento faster) +* Magento Open Source software only +* Magento Open Source software with sample data (designed to help you learn Magento faster) These packages are easy to get and install. You don't need to use Composer, all you need to do is to upload a package to your Magento server or hosted platform, unpack it, and run the web-based Setup Wizard. @@ -10,10 +10,10 @@ Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz` To get the Magento Open Source software archive: -1. Go to [http://magento.com/download](http://magento.com/download){:target="_blank"}. -2. Choose either the software or the software and sample data: +1. Go to [http://magento.com/download](http://magento.com/download){:target="_blank"}. +2. Choose either the software or the software and sample data: - * `Magento-CE-.*` (without sample data) - * `Magento-CE-+Samples.*` (with sample data) + * `Magento-CE-.*` (without sample data) + * `Magento-CE-+Samples.*` (with sample data) - `` is the three-digit release number (for example, `2.0.7`, `2.1.0`, and so on). \ No newline at end of file + `` is the three-digit release number (for example, `2.0.7`, `2.1.0`, and so on). \ No newline at end of file diff --git a/_includes/install/releasenotes/get-ee-software_zip.md b/_includes/install/releasenotes/get-ee-software_zip.md index 3ce4d6b5fab..2f32209c90e 100644 --- a/_includes/install/releasenotes/get-ee-software_zip.md +++ b/_includes/install/releasenotes/get-ee-software_zip.md @@ -1,8 +1,8 @@ The following table discusses where to get the Magento software. We provide the following downloads: -* Magento Commerce software only -* Magento Commerce software with sample data (designed to help you learn Magento faster) +* Magento Commerce software only +* Magento Commerce software with sample data (designed to help you learn Magento faster) These packages are easy to get and install. You don't need to use Composer, all you need to do is to upload a package to your Magento server or hosted platform, unpack it, and run the web-based Setup Wizard. @@ -10,13 +10,13 @@ Archives are available in the following formats: `.zip`, `.tar.bz2`, `.tar.gz` To get the Magento Commerce archive: -1. Go to [your account on magento.com](https://www.magentocommerce.com/products/customer/account/login/){:target="_blank"}. -3. Log in with your Magento username and password. -4. In the left navigation bar, click **Downloads**. -5. In the right pane, click **Magento Commerce 2.X** > **Full Release** or **Magento Commerce 2.X** > **Full Release + Sample Data** for the software. -6. Follow the instructions on your screen to complete the Magento Commerce download: +1. Go to [your account on magento.com](https://www.magentocommerce.com/products/customer/account/login/){:target="_blank"}. +3. Log in with your Magento username and password. +4. In the left navigation bar, click **Downloads**. +5. In the right pane, click **Magento Commerce 2.X** > **Full Release** or **Magento Commerce 2.X** > **Full Release + Sample Data** for the software. +6. Follow the instructions on your screen to complete the Magento Commerce download: - * `Magento-EE-.*` (without sample data) - * `Magento-EE-+Samples.*` (with sample data) + * `Magento-EE-.*` (without sample data) + * `Magento-EE-+Samples.*` (with sample data) -7. Transfer the installation package to your development system. \ No newline at end of file +7. Transfer the installation package to your development system. \ No newline at end of file diff --git a/_includes/install/sampledata/sample-data-other-cmds.md b/_includes/install/sampledata/sample-data-other-cmds.md index 2cba0c75044..a40781683fd 100644 --- a/_includes/install/sampledata/sample-data-other-cmds.md +++ b/_includes/install/sampledata/sample-data-other-cmds.md @@ -2,10 +2,10 @@ This topic discusses how to: -* [Remove sample data modules](#inst-sample-remove) from the Magento installation `composer.json` +* [Remove sample data modules](#inst-sample-remove) from the Magento installation `composer.json` - This option does *not* remove sample data from the database. -* [Prepare to update sample data](#inst-sample-reset) (for example, before updating the Magento application). + This option does *not* remove sample data from the database. +* [Prepare to update sample data](#inst-sample-reset) (for example, before updating the Magento application). ## First steps {#sample-first} @@ -15,7 +15,7 @@ This topic discusses how to: Enter the following command: - bin/magento sampledata:remove + bin/magento sampledata:remove The complete list of sample data modules follows: @@ -27,6 +27,6 @@ This command enables you to update sample data before you update the Magento app To prepare sample data for updating, enter the following command: - bin/magento sampledata:reset + bin/magento sampledata:reset After that, [update the Magento application]({{ page.baseurl }}/install-gde/install/cli/install-cli-uninstall.html#instgde-install-magento-update). diff --git a/_includes/install/sampledata/sample-data-rc1-cli.md b/_includes/install/sampledata/sample-data-rc1-cli.md index 13bc72a2d41..08af7f145f3 100644 --- a/_includes/install/sampledata/sample-data-rc1-cli.md +++ b/_includes/install/sampledata/sample-data-rc1-cli.md @@ -2,8 +2,8 @@ These instructions apply to {{site.data.var.ce}} and {{site.data.var.ee}} users *only* if all of the following are true: -* You have installed optional sample data -* You are upgrading to Magento {{ page.guide_version }} (including a Release Candidate) from any earlier version using the command line +* You have installed optional sample data +* You are upgrading to Magento {{ page.guide_version }} (including a Release Candidate) from any earlier version using the command line To upgrade to Magento {{ page.guide_version }} sample data using the command line: @@ -37,31 +37,31 @@ To upgrade to Magento {{ page.guide_version }} sample data using the command lin {% include note.html type="info" - content="To upgrade to a Release Candidate, append `-rc` to the version of each module. For example, `-rc3`." - %} + content="To upgrade to a Release Candidate, append `-rc` to the version of each module. For example, `-rc3`." + %} -1. Update dependencies: - ```bash - composer update - ``` -1. If prompted, enter your [authentication keys]. -1. Wait for dependencies to update. +1. Update dependencies: + ```bash + composer update + ``` +1. If prompted, enter your [authentication keys]. +1. Wait for dependencies to update. ### Finish your upgrade After you have reset file system permissions: -1. If you haven't done so already, log in to your Magento server as, or switch to, the Magento file system owner. -1. Change to your Magento installation directory. -1. Manually clear the `var/cache`, `var/page_cache`, and `var/generation` directories. - A sample command follows: +1. If you haven't done so already, log in to your Magento server as, or switch to, the Magento file system owner. +1. Change to your Magento installation directory. +1. Manually clear the `var/cache`, `var/page_cache`, and `var/generation` directories. + A sample command follows: ```bash - rm -rf var/cache/* var/page_cache/* var/generation/* - ``` -1. Upgrade Magento: + rm -rf var/cache/* var/page_cache/* var/generation/* + ``` +1. Upgrade Magento: ```bash - php bin/magento setup:upgrade - ``` + php bin/magento setup:upgrade + ``` {% include install/sampledata/file-sys-perms-digest.md %} diff --git a/_includes/install/sampledata/sample-data-rc1-web.md b/_includes/install/sampledata/sample-data-rc1-web.md index 419fa184e2f..f04e1f5ceda 100644 --- a/_includes/install/sampledata/sample-data-rc1-web.md +++ b/_includes/install/sampledata/sample-data-rc1-web.md @@ -1,27 +1,27 @@ These instructions apply to you *only* if all of the following are true: -* You're using Magento Enterprise Edition (EE) -* You have installed optional sample data -* You're upgrading to {{site.data.var.ee}} RC1 or {{site.data.var.ee}} RC2 from any earlier version using the Setup Wizard +* You're using Magento Enterprise Edition (EE) +* You have installed optional sample data +* You're upgrading to {{site.data.var.ee}} RC1 or {{site.data.var.ee}} RC2 from any earlier version using the Setup Wizard To upgrade to {{site.data.var.ee}} RC1 or RC2 with sample data using the Setup Wizard: {% collapsible Click to expand/collapse content %} -1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). -2. Change to the Magento installation directory. -3. Open `composer.lock` in a text editor. -4. Change the following: +1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). +2. Change to the Magento installation directory. +3. Open `composer.lock` in a text editor. +4. Change the following: - From: + From: - "type": "magento2-module-customer-balance" + "type": "magento2-module-customer-balance" - To: + To: - "type": "magento2-module" -5. Save your changes to `composer.lock` and exit the text editor. + "type": "magento2-module" +5. Save your changes to `composer.lock` and exit the text editor. {% include install/sampledata/file-sys-perms-digest.md %} diff --git a/_includes/install/sampledata/sample-data_list-of-modules.md b/_includes/install/sampledata/sample-data_list-of-modules.md index 6d52784a4d3..fd8546e6b02 100644 --- a/_includes/install/sampledata/sample-data_list-of-modules.md +++ b/_includes/install/sampledata/sample-data_list-of-modules.md @@ -1,33 +1,33 @@ {{site.data.var.ce}} and {{site.data.var.ee}}: -* magento/module-bundle-sample-data -* magento/module-catalog-rule-sample-data -* magento/module-catalog-sample-data -* magento/module-cms-sample-data -* magento/module-configurable-sample-data -* magento/module-customer-sample-data -* magento/module-downloadable-sample-data -* magento/module-grouped-product-sample-data -* magento/module-msrp-sample-data -* magento/module-offline-shipping-sample-data -* magento/module-product-links-sample-data -* magento/module-review-sample-data -* magento/module-sales-rule-sample-data -* magento/module-sales-sample-data -* magento/module-sample-data -* magento/module-swatches-sample-data -* magento/module-tax-sample-data -* magento/module-theme-sample-data -* magento/module-widget-sample-data -* magento/module-wishlist-sample-data -* magento/sample-data -* magento/sample-data-media +* magento/module-bundle-sample-data +* magento/module-catalog-rule-sample-data +* magento/module-catalog-sample-data +* magento/module-cms-sample-data +* magento/module-configurable-sample-data +* magento/module-customer-sample-data +* magento/module-downloadable-sample-data +* magento/module-grouped-product-sample-data +* magento/module-msrp-sample-data +* magento/module-offline-shipping-sample-data +* magento/module-product-links-sample-data +* magento/module-review-sample-data +* magento/module-sales-rule-sample-data +* magento/module-sales-sample-data +* magento/module-sample-data +* magento/module-swatches-sample-data +* magento/module-tax-sample-data +* magento/module-theme-sample-data +* magento/module-widget-sample-data +* magento/module-wishlist-sample-data +* magento/sample-data +* magento/sample-data-media {{site.data.var.ee}} only: -* magento/module-customer-balance-sample-data -* magento/module-gift-card-sample-data -* magento/module-gift-registry-sample-data -* magento/module-multiple-wishlist-sample-data -* magento/module-target-rule-sample-data +* magento/module-customer-balance-sample-data +* magento/module-gift-card-sample-data +* magento/module-gift-registry-sample-data +* magento/module-multiple-wishlist-sample-data +* magento/module-target-rule-sample-data diff --git a/_includes/install/sens-data.md b/_includes/install/sens-data.md index 422c2580b4b..da0b517fae1 100644 --- a/_includes/install/sens-data.md +++ b/_includes/install/sens-data.md @@ -2,13 +2,13 @@ Magento uses your encryption key to encrypt the following: -* Credit card information -* Usernames and passwords specified in the Magento Admin configuration (for example, logins to payment gateways) -* CAPTCHA values sent over the network +* Credit card information +* Usernames and passwords specified in the Magento Admin configuration (for example, logins to payment gateways) +* CAPTCHA values sent over the network Magento does *not* encrypt: -* Administrative and customer usernames and passwords (these passwords are hashed) -* Address -* Phone number -* Other types of personally identifiable information except for credit card numbers +* Administrative and customer usernames and passwords (these passwords are hashed) +* Address +* Phone number +* Other types of personally identifiable information except for credit card numbers diff --git a/_includes/install/tls-repo.md b/_includes/install/tls-repo.md index f8acc4eecc9..4c9c1b826b3 100644 --- a/_includes/install/tls-repo.md +++ b/_includes/install/tls-repo.md @@ -12,9 +12,9 @@ If you have an earlier version of TLS, you'll see the errors discussed in this s The following error displays if you attempt to run `composer create-project` to get a Magento metapackage: - [Composer\Downloader\TransportException] - The "https://repo.magento.com/packages.json" file could not be downloaded: Failed to enable crypto - failed to open stream: operation failed + [Composer\Downloader\TransportException] + The "https://repo.magento.com/packages.json" file could not be downloaded: Failed to enable crypto + failed to open stream: operation failed ### Using the Web Setup Wizard diff --git a/_includes/install/trouble/rc_cron.md b/_includes/install/trouble/rc_cron.md index 3ed7671c293..61bc4582b90 100644 --- a/_includes/install/trouble/rc_cron.md +++ b/_includes/install/trouble/rc_cron.md @@ -5,41 +5,41 @@ This section discusses how to see if cron is currently running and to verify whe To verify whether or not your crontab is set up: -1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). -2. See if the following file exists: +1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). +2. See if the following file exists: ```bash - ls -al /var/.setup_cronjob_status - ``` + ls -al /var/.setup_cronjob_status + ``` - If the file exists, cron has run successfully in the past. If the file _does not_ exist, either you haven't yet installed Magento or cron isn't running. In either case, continue with the next step. -3. Get more detail about cron. + If the file exists, cron has run successfully in the past. If the file _does not_ exist, either you haven't yet installed Magento or cron isn't running. In either case, continue with the next step. +3. Get more detail about cron. - As a user with `root` privileges, enter the following command: + As a user with `root` privileges, enter the following command: - ```bash - crontab -u -l - ``` + ```bash + crontab -u -l + ``` - For example, on CentOS + For example, on CentOS - ```bash - crontab -u magento_user -l - ``` + ```bash + crontab -u magento_user -l + ``` - If no crontab has been set up for the user, the following message displays: + If no crontab has been set up for the user, the following message displays: - ```terminal - no crontab for magento_user - ``` + ```terminal + no crontab for magento_user + ``` - Your crontab tells you the following: + Your crontab tells you the following: - * What PHP binary you're using (in some cases, you have more than one) - * What Magento cron scripts you're running (in particular, the paths to those scripts) - * Where your cron logs are located + * What PHP binary you're using (in some cases, you have more than one) + * What Magento cron scripts you're running (in particular, the paths to those scripts) + * Where your cron logs are located - See one of the following sections for a solution to your issue. + See one of the following sections for a solution to your issue. ### Solution: crontab not set up diff --git a/_includes/install/trouble/rc_php-version.md b/_includes/install/trouble/rc_php-version.md index 7bba3349c53..19e0995243d 100644 --- a/_includes/install/trouble/rc_php-version.md +++ b/_includes/install/trouble/rc_php-version.md @@ -25,13 +25,13 @@ We assume that if you have this issue, you're an advanced user who has likely in To resolve the issue, try the following: -* Restart your web server or php-fm. -* Check the `$PATH` environment variable for multiple paths to PHP -* Use the `which php` command to locate the first PHP executable in your path; if it's not correct, remove it or create a symlink to the correct PHP version -* Use a [`phpinfo.php`]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo) page to collect more information -* Make sure you're running a supported PHP version according to our System Requirements: +* Restart your web server or php-fm. +* Check the `$PATH` environment variable for multiple paths to PHP +* Use the `which php` command to locate the first PHP executable in your path; if it's not correct, remove it or create a symlink to the correct PHP version +* Use a [`phpinfo.php`]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo) page to collect more information +* Make sure you're running a supported PHP version according to our System Requirements: - * [Version 2.2]({{ site.gdeurl22 }}install-gde/system-requirements.html) - * [Version 2.3]({{ site.gdeurl23 }}install-gde/system-requirements.html) + * [Version 2.2]({{ site.gdeurl22 }}install-gde/system-requirements.html) + * [Version 2.3]({{ site.gdeurl23 }}install-gde/system-requirements.html) -* Set the same PHP settings for both the PHP command line and the PHP web server plug-in as discussed in [PHP configuration options]({{ page.baseurl }}/install-gde/prereq/php-centos.html) +* Set the same PHP settings for both the PHP command line and the PHP web server plug-in as discussed in [PHP configuration options]({{ page.baseurl }}/install-gde/prereq/php-centos.html) diff --git a/_includes/install/ulimit.md b/_includes/install/ulimit.md index 6005e2ed859..f93a0e6ab5f 100644 --- a/_includes/install/ulimit.md +++ b/_includes/install/ulimit.md @@ -14,7 +14,7 @@ Before you continue, if you haven't done so already, switch to the [Magento file Command: - ulimit -s 65536 + ulimit -s 65536 You can change this to a larger value if needed. @@ -23,13 +23,13 @@ The syntax for `ulimit` depends on the UNIX shell you use. The preceding setting To optionally set the value in the user's Bash shell: -1. If you haven't done so already, switch to the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). -2. Open `/home//.bashrc` in a text editor. -3. Add the following line: +1. If you haven't done so already, switch to the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). +2. Open `/home//.bashrc` in a text editor. +3. Add the following line: - ulimit -s 65536 + ulimit -s 65536 -4. Save your changes to `.bashrc` and exit the text editor. +4. Save your changes to `.bashrc` and exit the text editor. {:.bs-callout .bs-callout-warning} We recommend you avoid setting a value for [`pcre.recursion_limit`](http://php.net/manual/en/pcre.configuration.php) in `php.ini` because it can result in incomplete rollbacks with no failure notice. diff --git a/_includes/install/web/install-web.md b/_includes/install/web/install-web.md index 342b7fe672c..25534d064db 100644 --- a/_includes/install/web/install-web.md +++ b/_includes/install/web/install-web.md @@ -4,9 +4,9 @@ This section discusses how to install the Magento software using a web-based wiz Before you begin, make sure that: -1. Your system meets the requirements discussed in [Magento System Requirements]({{ page.baseurl }}/install-gde/system-requirements.html). -2. You completed all prerequisite tasks discussed in [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html). -4. After you log in to the Magento server, [switch to the Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). +1. Your system meets the requirements discussed in [Magento System Requirements]({{ page.baseurl }}/install-gde/system-requirements.html). +2. You completed all prerequisite tasks discussed in [Prerequisites]({{ page.baseurl }}/install-gde/prereq/prereq-overview.html). +4. After you log in to the Magento server, [switch to the Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). ### Enabling and disabling modules {#instgde-install-web-enable-mod} @@ -24,16 +24,16 @@ In the event of errors, you can run the installer again or you can return to a p To install the Magento software using the Setup Wizard: -1. Start a web browser. +1. Start a web browser. -2. Enter the following URL in the browser's address or location bar: +2. Enter the following URL in the browser's address or location bar: - http:////setup + http:////setup - For example, if the Magento server's IP address is 192.0.2.10 and you installed Magento 2 in the `magento2/` directory relative to the web server's docroot, and you did not configure a Virtual Host, enter: + For example, if the Magento server's IP address is 192.0.2.10 and you installed Magento 2 in the `magento2/` directory relative to the web server's docroot, and you did not configure a Virtual Host, enter: - http://192.0.2.10/magento2/setup + http://192.0.2.10/magento2/setup -3. On the initial page, click **Agree and Set Up Magento**. +3. On the initial page, click **Agree and Set Up Magento**. -4. Continue with the following topics in the order presented to complete the installation. +4. Continue with the following topics in the order presented to complete the installation. diff --git a/_includes/install/web/install-web_1-readiness.md b/_includes/install/web/install-web_1-readiness.md index 89ab9f0fed5..86010d0fd9d 100644 --- a/_includes/install/web/install-web_1-readiness.md +++ b/_includes/install/web/install-web_1-readiness.md @@ -1,9 +1,9 @@ ## Step 1: Readiness Check {#instgde-install-magento-web-step1} -1. Click **Start Readiness Check**. +1. Click **Start Readiness Check**. - If any errors display, you must resolve them before you continue. + If any errors display, you must resolve them before you continue. - Click **More detail** if available to see more information about each check. + Click **More detail** if available to see more information about each check. -2. Click **Next**. +2. Click **Next**. diff --git a/_includes/install/web/install-web_2-db.md b/_includes/install/web/install-web_2-db.md index 6ed783ab9bf..fcaca682e92 100644 --- a/_includes/install/web/install-web_2-db.md +++ b/_includes/install/web/install-web_2-db.md @@ -1,37 +1,37 @@ ## Step 2: Add a Database {#instgde-install-magento-web-step2} -1. Enter the following information: +1. Enter the following information: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ItemDescription
    Database Server HostIf the web server and database server are located on the same host, enter localhost. If the database server is located on a different host, enter its fully qualified hostname or IP address.
    Database Server UsernameEnter the username of the Magento database instance owner.
    Database Server PasswordEnter the Magento database user's password, if any. Leave this field blank if you did not configure a password.
    Database NameEnter the Magento database instance name.
    Table prefix

    Use only if you're installing the Magento database tables in a database instance that has Magento tables in it already.

    -

    In that case, use a prefix to identify the Magento tables for this installation. Some customers have more than one Magento instance running on a server with all tables in the same database.

    -

    The prefix can be a maximum of five characters in length. It must begin with a letter and can include only letters, numbers, and underscore characters.

    -

    This option enables those customers to share the database server with more than one Magento installation.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ItemDescription
    Database Server HostIf the web server and database server are located on the same host, enter localhost. If the database server is located on a different host, enter its fully qualified hostname or IP address.
    Database Server UsernameEnter the username of the Magento database instance owner.
    Database Server PasswordEnter the Magento database user's password, if any. Leave this field blank if you did not configure a password.
    Database NameEnter the Magento database instance name.
    Table prefix

    Use only if you're installing the Magento database tables in a database instance that has Magento tables in it already.

    +

    In that case, use a prefix to identify the Magento tables for this installation. Some customers have more than one Magento instance running on a server with all tables in the same database.

    +

    The prefix can be a maximum of five characters in length. It must begin with a letter and can include only letters, numbers, and underscore characters.

    +

    This option enables those customers to share the database server with more than one Magento installation.

    -3. Click **Next**. +3. Click **Next**. diff --git a/_includes/install/web/install-web_3-web-conf.md b/_includes/install/web/install-web_3-web-conf.md index 4c2612adb11..e55699166fc 100644 --- a/_includes/install/web/install-web_3-web-conf.md +++ b/_includes/install/web/install-web_3-web-conf.md @@ -1,13 +1,13 @@ ## Step 3: Web Configuration {#instgde-install-magento-web-step3} -1. Enter the following information: +1. Enter the following information: |Item|Description| |--- |--- | |Your Store Address|Enter the URL, including scheme and trailing slash, by which users access your storefront. For example, if your storefront hostname is http://www.example.com, enter http://www.example.com/| |Magento Admin Address|Enter the relative URL by which to access the Magento Admin.| -2. Optionally click **Advanced Options** and enter the following information: +2. Optionally click **Advanced Options** and enter the following information: |Item|Description| |--- |--- | @@ -16,6 +16,6 @@ |Encryption Key|Magento uses an encryption key to encrypt [sensitive data](#sens-data) in the database.

    Click I want to use a Magento generated key to have Magento generate an encryption key for you.

    Click I want to use my own encryption key if you already have an encryption key.| |Session Save|From the list, click the option corresponding to how to store session data.

    The default is Files, which means session data is saved in the var/session subdirectory of the Magento file system.

    You can also choose Db, which means session data is stored in the database.| -12. Click **Next**. +12. Click **Next**. {% include install/sens-data.md %} diff --git a/_includes/install/web/install-web_4-customize-store.md b/_includes/install/web/install-web_4-customize-store.md index 7e6f592d031..d3470ea0931 100644 --- a/_includes/install/web/install-web_4-customize-store.md +++ b/_includes/install/web/install-web_4-customize-store.md @@ -1,21 +1,21 @@ ## Step 4: Customize Your Store {#instgde-install-magento-web-step4} -1. From the **Store Default Time Zone** list, click the name of your store's time zone. +1. From the **Store Default Time Zone** list, click the name of your store's time zone. -2. From the **Store Default Currency** list, click the default currency to use in your store. +2. From the **Store Default Currency** list, click the default currency to use in your store. -3. From the **Store Default Language** list, click the default language to use in your store. +3. From the **Store Default Language** list, click the default language to use in your store. -3. Expand **Advanced Modules Configuration** to optionally enable or disable modules before you install the Magento software. +3. Expand **Advanced Modules Configuration** to optionally enable or disable modules before you install the Magento software. - Before you enable or disable modules, review the information discussed in [Enabling and disabling modules]({{ page.baseurl }}/install-gde/install/web/install-web.html#instgde-install-web-enable-mod). + Before you enable or disable modules, review the information discussed in [Enabling and disabling modules]({{ page.baseurl }}/install-gde/install/web/install-web.html#instgde-install-web-enable-mod). - See one of the following sections for more information about enabling and disabling modules: + See one of the following sections for more information about enabling and disabling modules: - * [General module configuration options](#instgde-install-magento-web-step4-depend1) - * [Module dependency errors](#instgde-install-magento-web-step4-depend2) + * [General module configuration options](#instgde-install-magento-web-step4-depend1) + * [Module dependency errors](#instgde-install-magento-web-step4-depend2) -4. Click **Next**. +4. Click **Next**. #### General module configuration options {#instgde-install-magento-web-step4-depend1} @@ -23,11 +23,11 @@ Modules are listed in **Advanced Modules Configuration** in alphabetical order; You have the following options for any module listed: -* To enable a module that is currently disabled, select its checkbox. -* To disable a module that is currently enabled, clear its checkbox. -* Use the **Select All** checkbox to: - * Enable all modules if any module is currently disabled. - * Disable all available modules (that is, all modules that do not depend on other enabled modules). +* To enable a module that is currently disabled, select its checkbox. +* To disable a module that is currently enabled, clear its checkbox. +* Use the **Select All** checkbox to: + * Enable all modules if any module is currently disabled. + * Disable all available modules (that is, all modules that do not depend on other enabled modules). If a module's checkbox is unavailable, some other module depends on it. In the case of a dependency, to change the state of that module, you must first perform the corresponding action on the module on which it depends. @@ -46,8 +46,8 @@ If there is a dependency error, a message similar to the following displays. Click **Show details** to display details about the dependency error. You can then do any of the following: -* Select the **Skip dependency check for individual modules** to ignore the issue and continue with your installation. (Additional dependency checks are performed after you click **Next**.) -* Resolve the issue by taking the action indicated by the message. +* Select the **Skip dependency check for individual modules** to ignore the issue and continue with your installation. (Additional dependency checks are performed after you click **Next**.) +* Resolve the issue by taking the action indicated by the message. {:.bs-callout .bs-callout-warning} Use Skip dependency check for individual modules with caution. We recommend against it because a typical reason for this error is you manually edited the [deployment configuration]({{ page.baseurl }}/config-guide/config/config-php.html). Editing the deployment configuration is not recommended because future Magento software updates can undo your changes. diff --git a/_includes/install/web/install-web_5-create-admin.md b/_includes/install/web/install-web_5-create-admin.md index a7c54bb6217..716eea9bb8e 100644 --- a/_includes/install/web/install-web_5-create-admin.md +++ b/_includes/install/web/install-web_5-create-admin.md @@ -1,6 +1,6 @@ ## Step 5: Create Admin Account {#instgde-install-magento-web-step5} -1. Enter the following information: +1. Enter the following information: |Item|Description| |--- |--- | @@ -9,4 +9,4 @@ |New Password|Enter the administrator's password.| |Confirm Password|Enter the password again for verification.| -2. Click **Next**. +2. Click **Next**. diff --git a/_includes/install/web/install-web_6-install.md b/_includes/install/web/install-web_6-install.md index d74894aed81..eab080c6ad6 100644 --- a/_includes/install/web/install-web_6-install.md +++ b/_includes/install/web/install-web_6-install.md @@ -4,9 +4,9 @@ After completing all preceding steps in the Setup Wizard, click **Install Now**. You have the following options: -* To see installation progress or error details, click **Console Log**. -* In the event of problems, click **Previous** to go back and fix incorrect entries. -* To try the installation again in the event of failure, click **Try Again**. +* To see installation progress or error details, click **Console Log**. +* In the event of problems, click **Previous** to go back and fix incorrect entries. +* To try the installation again in the event of failure, click **Try Again**. ### Installation Success {#instgde-install-magento-web-step5last} @@ -22,17 +22,17 @@ The Setup Wizard creates a log file, named `install.log`, that you might find us The Setup Wizard uses the [sys_get_temp_dir ( void )](http://php.net/manual/en/function.sys-get-temp-dir.php) PHP call to determine where to write the installation log. To locate the log: -1. Open `php.ini` in a text editor. +1. Open `php.ini` in a text editor. - If you don't know where `php.ini` is located: + If you don't know where `php.ini` is located: - 1. Log in as or switch to the [switch to the Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). - 2. Create [phpinfo.php]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo) in the web server's docroot. - 3. Access `phpinfo.php` in a web browser. + 1. Log in as or switch to the [switch to the Magento file system owner]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html). + 2. Create [phpinfo.php]({{ page.baseurl }}/install-gde/prereq/optional.html#install-optional-phpinfo) in the web server's docroot. + 3. Access `phpinfo.php` in a web browser. - The location of `php.ini` is typically specified as **Loaded Configuration File** in the displayed results. + The location of `php.ini` is typically specified as **Loaded Configuration File** in the displayed results. -2. Search for `sys_temp_dir`. +2. Search for `sys_temp_dir`. The value of `sys_temp_dir` determines where `install.log` is located. If the value is commented out, PHP uses that value as its default. diff --git a/_includes/layout/page-header.html b/_includes/layout/page-header.html index 5f6fe24c7ca..cd3c3acf137 100644 --- a/_includes/layout/page-header.html +++ b/_includes/layout/page-header.html @@ -1,12 +1,12 @@
    - {% if page.ee_only == true %} - {{site.data.var.ee}} only - {% endif %} + {% if page.ee_only == true %} + {{site.data.var.ee}} only + {% endif %} - {% if page.subtitle %} -

    {{ page.subtitle }}

    - {% endif %} + {% if page.subtitle %} +

    {{ page.subtitle }}

    + {% endif %} -

    {{ page.title }}

    +

    {{ page.title }}

    diff --git a/_includes/layout/sidebar.html b/_includes/layout/sidebar.html index 53e17caab22..1664f99e6d6 100644 --- a/_includes/layout/sidebar.html +++ b/_includes/layout/sidebar.html @@ -1,20 +1,20 @@ diff --git a/_includes/layout/version-switcher.html b/_includes/layout/version-switcher.html index aa33434d124..001ef67e85f 100644 --- a/_includes/layout/version-switcher.html +++ b/_includes/layout/version-switcher.html @@ -6,20 +6,20 @@ {% if versions.size > 1 %}
    - -
    {% elsif versions.size == 1 %}
    - +
    {% endif %} diff --git a/_includes/m1x/eol_message.html b/_includes/m1x/eol_message.html index 7ff4de61c12..127ec6f196a 100644 --- a/_includes/m1x/eol_message.html +++ b/_includes/m1x/eol_message.html @@ -4,6 +4,6 @@

    Magento 1.x Software Support Notice

    For Magento Commerce 1, Magento is providing software support through June 2020. Depending on your Magento Commerce 1 version, software support may include both quality fixes and security patches. Please review our Magento Software Lifecycle Policy to see how your version of Magento Commerce 1 is supported.

    - For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business. + For Magento Open Source 1.5 to 1.9, Magento is providing software security patches through June 2020 to ensure those sites remain secure and compliant. Visit our information page for more details about our software maintenance policy and other considerations for your business.

    diff --git a/_includes/php-dev/component-root-2.3.md b/_includes/php-dev/component-root-2.3.md index eae45cfa3de..16b0d39faaa 100644 --- a/_includes/php-dev/component-root-2.3.md +++ b/_includes/php-dev/component-root-2.3.md @@ -17,6 +17,6 @@ Magento installs third-party components in the `vendor` directory. But we recomm All components require these three files: -* `registration.php`: This file registers your component with Magento. It uses the component's root directory name as the component name. By default, the composer installs components in the `/vendor` directory. For more information, see [Component registration]({{page.baseurl}}/extension-dev-guide/build/component-registration.html). -* `etc/module.xml`: This file defines basic information about the component, such as component dependencies and version number. Magento uses the version number to determine which schema and data to update when executing `bin/magento setup:upgrade`. -* `composer.json`: This file defines the dependencies that the component needs at runtime. For more information, see [Composer integration]({{page.baseurl}}/extension-dev-guide/build/composer-integration.html). +* `registration.php`: This file registers your component with Magento. It uses the component's root directory name as the component name. By default, the composer installs components in the `/vendor` directory. For more information, see [Component registration]({{page.baseurl}}/extension-dev-guide/build/component-registration.html). +* `etc/module.xml`: This file defines basic information about the component, such as component dependencies and version number. Magento uses the version number to determine which schema and data to update when executing `bin/magento setup:upgrade`. +* `composer.json`: This file defines the dependencies that the component needs at runtime. For more information, see [Composer integration]({{page.baseurl}}/extension-dev-guide/build/composer-integration.html). diff --git a/_includes/php-dev/component-root.md b/_includes/php-dev/component-root.md index c4c0122bb42..54b51b92e0e 100644 --- a/_includes/php-dev/component-root.md +++ b/_includes/php-dev/component-root.md @@ -11,12 +11,12 @@ A component's root directory is the top-level directory for that component under * `/vendor`: This location is found in the alternative setups where the {% if page.guide_version == "2.0" %} [`composer create-project`]({{page.baseurl}}/install-gde/prereq/integrator_install.html) {% else %} [`composer create-project`]({{page.baseurl}}/install-gde/composer.html). {% endif %} command was used to get a Magento 2 metapackage (which downloads the CE or EE code), or a [compressed Magento 2 archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html) was extracted in order to install Magento. - Any third party components (and the Magento application itself) are downloaded and stored under the `vendor` directory. If you are using Git to manage project, this directory is typically added to the `.gitignore` file. Therefore, we recommend you do your customization work in `app/code`, not `vendor`. + Any third party components (and the Magento application itself) are downloaded and stored under the `vendor` directory. If you are using Git to manage project, this directory is typically added to the `.gitignore` file. Therefore, we recommend you do your customization work in `app/code`, not `vendor`. ### Required files The following files are required for all components: -* `registration.php`: Among other things, this file specifies the directory in which the component is installed by vendors in production environments. By default, composer automatically installs components in the `/vendor` directory. For more information, see [Component registration]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html). -* `etc/module.xml`: This file specifies basic information about the component such as the components dependencies and its version number. This version number is used to determine schema and data updates when `bin/magento setup:upgrade` is run. -* `composer.json`: Specifies component dependencies and other metadata. For more information, see [Composer integration]({{ page.baseurl }}/extension-dev-guide/build/composer-integration.html). +* `registration.php`: Among other things, this file specifies the directory in which the component is installed by vendors in production environments. By default, composer automatically installs components in the `/vendor` directory. For more information, see [Component registration]({{ page.baseurl }}/extension-dev-guide/build/component-registration.html). +* `etc/module.xml`: This file specifies basic information about the component such as the components dependencies and its version number. This version number is used to determine schema and data updates when `bin/magento setup:upgrade` is run. +* `composer.json`: Specifies component dependencies and other metadata. For more information, see [Composer integration]({{ page.baseurl }}/extension-dev-guide/build/composer-integration.html). diff --git a/_includes/php-dev/component-versioning.md b/_includes/php-dev/component-versioning.md index 91a04196d2c..b2bfb5edd33 100644 --- a/_includes/php-dev/component-versioning.md +++ b/_includes/php-dev/component-versioning.md @@ -1,9 +1,9 @@ Components have the following types of versions: -* Marketing version; in other words, the version the merchant interacts with. +* Marketing version; in other words, the version the merchant interacts with. - Your initial version might be 1.0.0 or 2.0.0, for example. You should follow [our versioning policy]({{ page.baseurl }}/extension-dev-guide/versioning) guidelines when setting your version. + Your initial version might be 1.0.0 or 2.0.0, for example. You should follow [our versioning policy]({{ page.baseurl }}/extension-dev-guide/versioning) guidelines when setting your version. -* Composer version; in other words, the version of each module, theme, language package, third-party package, and dependencies. +* Composer version; in other words, the version of each module, theme, language package, third-party package, and dependencies. Using Magento code as an example, {{site.data.var.ce}} marketing version 2.0.0 includes component versions such as 100.0.1, 100.0.2, and so on. These versioning strategy prevents collisions between the marketing version and component versions. diff --git a/codelinks/attributes.md b/codelinks/attributes.md index 2e9e7cc2f7d..a492eaabfc6 100644 --- a/codelinks/attributes.md +++ b/codelinks/attributes.md @@ -15,7 +15,7 @@ This document lists the PHP, REST, and SOAP calls that indicate they return deta Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `CustomerRepositoryInterface::getList($searchCriteria)` | `CustomerRepositoryInterface::getById($customerId)` -REST | `/V1/customers/search` | `/V1/customers/{id}` +REST | `/V1/customers/search` | `/V1/customers/{id}` SOAP | `customerCustomerRepositoryV1GetList` | `customerCustomerRepositoryV1GetById` ### Magento\Customer\Api\GroupRepositoryInterface {#GroupRepositoryInterface} @@ -23,7 +23,7 @@ SOAP | `customerCustomerRepositoryV1GetList` | `customerCustomerRepositoryV1GetB Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `GroupRepositoryInterface::getList($searchCriteria)` | `GroupRepositoryInterface::getById($id)` -REST | `/V1/customerGroups/search` | `/V1/customerGroups/{id}` +REST | `/V1/customerGroups/search` | `/V1/customerGroups/{id}` SOAP | `customerGroupRepositoryV1GetList` | `customerGroupRepositoryV1GetById` ## EAV module {#EAV} @@ -33,7 +33,7 @@ SOAP | `customerGroupRepositoryV1GetList` | `customerGroupRepositoryV1GetById` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `AttributeSetRepositoryInterface::getList($entityTypeCode, $searchCriteria)` | `AttributeSetRepositoryInterface::get($attributeSetId)` -REST | `/V1/eav/attribute-sets/list` | `/V1/eav/attribute-sets/{attributeSetId}` +REST | `/V1/eav/attribute-sets/list` | `/V1/eav/attribute-sets/{attributeSetId}` SOAP | `eavAttributeSetRepositoryV1GetList` | `eavAttributeSetRepositoryV1Get` ## GiftWrapping module (Enterprise Edition) {#GiftWrapping} @@ -42,8 +42,8 @@ SOAP | `eavAttributeSetRepositoryV1GetList` | `eavAttributeSetRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `WrappingRepositoryInterface::getList($searchCriteria)` | `WrappingRepositoryInterface::get($ruleId)` -REST | `/V1/gift-wrappings` | `/V1/gift-wrappings/:id` +PHP | `WrappingRepositoryInterface::getList($searchCriteria)` | `WrappingRepositoryInterface::get($ruleId)` +REST | `/V1/gift-wrappings` | `/V1/gift-wrappings/:id` SOAP | `giftWrappingWrappingRepositoryV1GetList` | `giftWrappingWrappingRepositoryV1Get` ## Quote module {#Quote} @@ -53,7 +53,7 @@ SOAP | `giftWrappingWrappingRepositoryV1GetList` | `giftWrappingWrappingReposito Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `CartRepositoryInterface::getList($searchCriteria)` | `CartRepositoryInterface::get($cartId)` -REST | `/V1/carts/search` | `/V1/carts/{cartId}` +REST | `/V1/carts/search` | `/V1/carts/{cartId}` SOAP | `quoteCartRepositoryV1GetList` | `quoteCartRepositoryV1Get` ### Magento\Quote\Api\GuestPaymentMethodManagementInterface {#GuestPaymentMethodManagementInterface} @@ -61,7 +61,7 @@ SOAP | `quoteCartRepositoryV1GetList` | `quoteCartRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `GuestPaymentMethodManagementInterface::getList($cartId)` | `GuestPaymentMethodManagementInterface::get($cartId)` -REST | `/V1/guest-carts/:cartId/payment-methods` | `/V1/guest-carts/:cartId/selected-payment-method` +REST | `/V1/guest-carts/:cartId/payment-methods` | `/V1/guest-carts/:cartId/selected-payment-method` SOAP | `quoteGuestPaymentMethodManagementV1GetList` | `quoteGuestPaymentMethodManagementV1Get` ### Magento\Quote\Api\PaymentMethodManagementInterface {#PaymentMethodManagementInterface} @@ -69,13 +69,13 @@ SOAP | `quoteGuestPaymentMethodManagementV1GetList` | `quoteGuestPaymentMethodMa Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `PaymentMethodManagementInterface::getList($cartId)` | `PaymentMethodManagementInterface::get($cartId)` -REST |`/V1/carts/:cartId/payment-methods` | `/V1/carts/:cartId/selected-payment-method` +REST |`/V1/carts/:cartId/payment-methods` | `/V1/carts/:cartId/selected-payment-method` SOAP | `quotePaymentMethodManagementV1GetList` | `quotePaymentMethodManagementV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `PaymentMethodManagementInterface::getList($cartId)` | `PaymentMethodManagementInterface::get($cartId)` -REST | `/V1/carts/mine/payment-methods` | `/V1/carts/mine/selected-payment-method` +REST | `/V1/carts/mine/payment-methods` | `/V1/carts/mine/selected-payment-method` SOAP | `quotePaymentMethodManagementV1GetList` | `quotePaymentMethodManagementV1Get` ## Sales module {#Sales} @@ -85,7 +85,7 @@ SOAP | `quotePaymentMethodManagementV1GetList` | `quotePaymentMethodManagementV1 Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `CreditmemoRepositoryInterface::getList($searchCriteria)` | `CreditmemoRepositoryInterface::get($id)` -REST | `/V1/creditmemos` | `/V1/creditmemo/{id}` +REST | `/V1/creditmemos` | `/V1/creditmemo/{id}` SOAP | `salesCreditmemoRepositoryV1GetList` | `salesCreditmemoRepositoryV1Get` ### Magento\Sales\Api\InvoiceRepositoryInterface {#InvoiceRepositoryInterface} @@ -93,7 +93,7 @@ SOAP | `salesCreditmemoRepositoryV1GetList` | `salesCreditmemoRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `InvoiceRepositoryInterface::getList($searchCriteria)` | `InvoiceRepositoryInterface::get($id)` -REST | `/V1/invoices` | `/V1/invoices/{id}` +REST | `/V1/invoices` | `/V1/invoices/{id}` SOAP | `salesInvoiceRepositoryV1GetList` | `salesInvoiceRepositoryV1Get` ### Magento\Sales\Api\OrderItemRepositoryInterface {#OrderItemRepositoryInterface} @@ -101,7 +101,7 @@ SOAP | `salesInvoiceRepositoryV1GetList` | `salesInvoiceRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `OrderItemRepositoryInterface::getList($searchCriteria)` | `OrderItemRepositoryInterface::get($id)` -REST | `/V1/orders/items` | `/V1/orders/items/{id}` +REST | `/V1/orders/items` | `/V1/orders/items/{id}` SOAP | `salesOrderItemRepositoryV1GetList` | `salesOrderItemRepositoryV1Get` ### Magento\Sales\Api\OrderRepositoryInterface {#OrderRepositoryInterface} @@ -109,7 +109,7 @@ SOAP | `salesOrderItemRepositoryV1GetList` | `salesOrderItemRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `OrderRepositoryInterface::getList($searchCriteria)` | `OrderRepositoryInterface::get($id)` -REST | `/V1/orders` | `/V1/orders/{id}` +REST | `/V1/orders` | `/V1/orders/{id}` SOAP | `salesOrderRepositoryV1GetList` | `salesOrderRepositoryV1GetList` ### Magento\Sales\Api\ShipmentRepositoryInterface {#ShipmentRepositoryInterface} @@ -117,7 +117,7 @@ SOAP | `salesOrderRepositoryV1GetList` | `salesOrderRepositoryV1GetList` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `ShipmentRepositoryInterface::getList($searchCriteria)` | `ShipmentRepositoryInterface::get($id)` -REST | `/V1/shipments` | `/V1/shipment/{id}` +REST | `/V1/shipments` | `/V1/shipment/{id}` SOAP | `salesShipmentRepositoryV1GetList` | `salesShipmentRepositoryV1Get` ### Magento\SalesRule\Api\TransactionRepositoryInterface {#TransactionRepositoryInterface} @@ -125,7 +125,7 @@ SOAP | `salesShipmentRepositoryV1GetList` | `salesShipmentRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- PHP | `TransactionRepositoryInterface::getList($searchCriteria)` | `TransactionRepositoryInterface:get($id)` -REST | `/V1/transactions` | `/V1/transactions/{id}` +REST | `/V1/transactions` | `/V1/transactions/{id}` SOAP | `salesTransactionRepositoryV1GetList` | `salesTransactionRepositoryV1Get` ## SalesRule module {#SalesRule} @@ -134,16 +134,16 @@ SOAP | `salesTransactionRepositoryV1GetList` | `salesTransactionRepositoryV1Get` Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `CouponRepositoryInterface::getList($searchCriteria)` | `CouponRepositoryInterface::getById($couponId)` -REST | `/V1/coupons/search` | `/V1/coupons/{couponId}` +PHP | `CouponRepositoryInterface::getList($searchCriteria)` | `CouponRepositoryInterface::getById($couponId)` +REST | `/V1/coupons/search` | `/V1/coupons/{couponId}` SOAP | `salesRuleCouponRepositoryV1GetList` | `salesRuleCouponRepositoryV1GetById` ### Magento\SalesRule\Api\RuleRepositoryInterface {#RuleRepositoryInterface} Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `RuleRepositoryInterface::getList($searchCriteria)` | `RuleRepositoryInterface::getById($ruleId)` -REST | `/V1/salesRules/search` | `/V1/salesRules/{ruleId}` +PHP | `RuleRepositoryInterface::getList($searchCriteria)` | `RuleRepositoryInterface::getById($ruleId)` +REST | `/V1/salesRules/search` | `/V1/salesRules/{ruleId}` SOAP | `salesRuleRuleRepositoryV1GetListRequest` | `salesRuleRuleRepositoryV1GetById` ## Tax module {#Tax} @@ -152,22 +152,22 @@ SOAP | `salesRuleRuleRepositoryV1GetListRequest` | `salesRuleRuleRepositoryV1Get Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `TaxClassRepositoryInterface::getList($searchCriteria)` | `TaxClassRepositoryInterface::get($taxClassId)` -REST | `/V1/taxClasses/search` | `/V1/taxClass/{rateId}` +PHP | `TaxClassRepositoryInterface::getList($searchCriteria)` | `TaxClassRepositoryInterface::get($taxClassId)` +REST | `/V1/taxClasses/search` | `/V1/taxClass/{rateId}` SOAP | `taxTaxClassRepositoryV1GetList` | `taxTaxClassRepositoryV1Get` ### Magento\Tax\Api\TaxRateRepositoryInterface {#TaxRateRepositoryInterface} Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `TaxRateRepositoryInterface::getList($searchCriteria)` | `TaxRateRepositoryInterface::get($rateId)` -REST | `/V1/taxRates/search` | `/V1/taxRates/{rateId}` +PHP | `TaxRateRepositoryInterface::getList($searchCriteria)` | `TaxRateRepositoryInterface::get($rateId)` +REST | `/V1/taxRates/search` | `/V1/taxRates/{rateId}` SOAP | `taxTaxRateRepositoryV1GetList` | `taxTaxRateRepositoryV1Get` ### Magento\Tax\Api\TaxRuleRepositoryInterface {#TaxRuleRepositoryInterface} Language | Does not return detailed attributes | Returns detailed attributes --- | --- | --- -PHP | `TaxRuleRepositoryInterface::getList($searchCriteria)` | `TaxRuleRepositoryInterface::get($ruleId)` -REST | `/V1/taxRules/search` | `/V1/taxRules/{ruleId}` +PHP | `TaxRuleRepositoryInterface::getList($searchCriteria)` | `TaxRuleRepositoryInterface::get($ruleId)` +REST | `/V1/taxRules/search` | `/V1/taxRules/{ruleId}` SOAP | `taxTaxRuleRepositoryV1GetList` | `taxTaxRuleRepositoryV1Get` diff --git a/guides/v2.2/architecture/tech-stack.md b/guides/v2.2/architecture/tech-stack.md index ec123afe448..899cf29cbb2 100644 --- a/guides/v2.2/architecture/tech-stack.md +++ b/guides/v2.2/architecture/tech-stack.md @@ -14,26 +14,26 @@ Magento's highly modular structure includes the following open-source technologi ### Web servers -* Apache -* [nginx](https://glossary.magento.com/nginx) +* Apache +* [nginx](https://glossary.magento.com/nginx) ### PHP -* [Composer](https://glossary.magento.com/composer) (dependency management package for PHP) +* [Composer](https://glossary.magento.com/composer) (dependency management package for PHP) ### Database -* MySQL -* MySQL Percona +* MySQL +* MySQL Percona ### HTTP accelerator -* Varnish +* Varnish ### Cache storage -* Redis -* Memcache +* Redis +* Memcache ### Search @@ -42,20 +42,20 @@ Magento's highly modular structure includes the following open-source technologi ### Additional technologies -* HTML5 -* CSS3 (Less [CSS](https://glossary.magento.com/css) pre-processor) -* [jQuery](https://glossary.magento.com/jquery) (primary [JavaScript](https://glossary.magento.com/javascript) library) -* RequireJS (library that helps load JavaScript resources on demand) -* Knockout.js (simplifies JavaScript UIs with the Model-View-View Model pattern) -* Third-party libraries (Zend Framework 1, Zend Framework 2, Symfony) -* Coding standards PSR-0 (autoloading standard), PSR-1 (basic coding standards), and PSR-2 (coding style guide), PSR-3, PSR-4 +* HTML5 +* CSS3 (Less [CSS](https://glossary.magento.com/css) pre-processor) +* [jQuery](https://glossary.magento.com/jquery) (primary [JavaScript](https://glossary.magento.com/javascript) library) +* RequireJS (library that helps load JavaScript resources on demand) +* Knockout.js (simplifies JavaScript UIs with the Model-View-View Model pattern) +* Third-party libraries (Zend Framework 1, Zend Framework 2, Symfony) +* Coding standards PSR-0 (autoloading standard), PSR-1 (basic coding standards), and PSR-2 (coding style guide), PSR-3, PSR-4 ### Optional stack components -* Varnish (caching) -* Redis (used for page caching) -* Solr (search engine) -* Elasticsearch (search engine) +* Varnish (caching) +* Redis (used for page caching) +* Solr (search engine) +* Elasticsearch (search engine) Magento 2.2 and above only supports PHP7+ and is no longer compatible with HipHop Virtual Machine(HHVM). diff --git a/guides/v2.2/b2b/company-object.md b/guides/v2.2/b2b/company-object.md index 61c7557b38d..fd139a76cc4 100644 --- a/guides/v2.2/b2b/company-object.md +++ b/guides/v2.2/b2b/company-object.md @@ -130,8 +130,8 @@ The following call changes the company status to Rejected (`2`) and explains why ```json { "company": { - "id": 2, - "company_name": "Test company", + "id": 2, + "company_name": "Test company", "company_email": "newemail@example.com", "customer_group_id": 1, "street":[ diff --git a/guides/v2.2/b2b/company-structures.md b/guides/v2.2/b2b/company-structures.md index 7fb43bce148..62e68421702 100644 --- a/guides/v2.2/b2b/company-structures.md +++ b/guides/v2.2/b2b/company-structures.md @@ -71,7 +71,7 @@ You can only change the name or description of a team. ```json { "team": { - "id": 4, + "id": 4, "name": "Western Region" } } diff --git a/guides/v2.2/b2b/company-users.md b/guides/v2.2/b2b/company-users.md index 93c7ec107cc..0596020a95c 100644 --- a/guides/v2.2/b2b/company-users.md +++ b/guides/v2.2/b2b/company-users.md @@ -66,19 +66,19 @@ Full example: ```json { - "customer": { - "email": "mshaw@example.com", - "firstname": "Melanie", - "lastname": "Shaw", - "extension_attributes": { - "company_attributes": { - "company_id": 2, - "status": 1, - "job_title": "Sales Rep", - "telephone": "512-555-3322" - } - } - } + "customer": { + "email": "mshaw@example.com", + "firstname": "Melanie", + "lastname": "Shaw", + "extension_attributes": { + "company_attributes": { + "company_id": 2, + "status": 1, + "job_title": "Sales Rep", + "telephone": "512-555-3322" + } + } + } } ``` diff --git a/guides/v2.2/b2b/negotiable-checkout.md b/guides/v2.2/b2b/negotiable-checkout.md index fba33d79a07..52a45c274cf 100644 --- a/guides/v2.2/b2b/negotiable-checkout.md +++ b/guides/v2.2/b2b/negotiable-checkout.md @@ -135,7 +135,7 @@ In this call, you specify the shipping and billing addresses, as well as the sel ```json { "addressInformation": { - "shipping_address": { + "shipping_address": { "region": "California", "region_id": 12, "country_id": "US", @@ -149,7 +149,7 @@ In this call, you specify the shipping and billing addresses, as well as the sel "lastname": "Doe" }, "billing_address": { - "region": "New York", + "region": "New York", "region_id": 43, "region_code": "NY", "country_id": "US", @@ -540,7 +540,7 @@ This call sets payment information and the billing address for the negotiable qu "method": "checkmo" }, "billing_address": { - "region": "New York", + "region": "New York", "region_id": 43, "region_code": "NY", "country_id": "US", @@ -577,7 +577,7 @@ This call sets payment information and the billing address for the negotiable qu "method": "checkmo" }, "billing_address": { - "region": "New York", + "region": "New York", "region_id": 43, "region_code": "NY", "country_id": "US", diff --git a/guides/v2.2/b2b/negotiable-manage.md b/guides/v2.2/b2b/negotiable-manage.md index 78350c852b1..bbf22293c66 100644 --- a/guides/v2.2/b2b/negotiable-manage.md +++ b/guides/v2.2/b2b/negotiable-manage.md @@ -35,9 +35,9 @@ The following table lists the parameters defined in `CompanyInterface`. Name | Description | Format | Requirements --- | --- | --- |--- -`quoteId` | Identifies the target quote for the operation. | integer | Required -`quoteName` | The name of the quote to be created. | string | Required -`comment` | The comment to add to the quote. | string | Optional +`quoteId` | Identifies the target quote for the operation. | integer | Required +`quoteName` | The name of the quote to be created. | string | Required +`comment` | The comment to add to the quote. | string | Optional `files` | An array of files to add to the quote | array | Optional The buyer or the seller can optionally attach up to 10 files to provide details about the quote. Each file must be converted into base64. diff --git a/guides/v2.2/b2b/negotiable-order-workflow.md b/guides/v2.2/b2b/negotiable-order-workflow.md index 8199bf2e833..4bac9b754e3 100644 --- a/guides/v2.2/b2b/negotiable-order-workflow.md +++ b/guides/v2.2/b2b/negotiable-order-workflow.md @@ -196,7 +196,7 @@ Authorization Bearer { "addressInformation": { "shipping_address": { - "region": "California", + "region": "California", "region_id": 12, "region_code": "CA", "country_id": "US", @@ -211,7 +211,7 @@ Authorization Bearer "telephone": "415-555-1212" }, "billing_address": { - "region": "California", + "region": "California", "region_id": 12, "region_code": "CA", "country_id": "US", diff --git a/guides/v2.2/b2b/shared-cat-product-assign.md b/guides/v2.2/b2b/shared-cat-product-assign.md index 3a3b5aabbb4..0d22f085027 100644 --- a/guides/v2.2/b2b/shared-cat-product-assign.md +++ b/guides/v2.2/b2b/shared-cat-product-assign.md @@ -165,26 +165,26 @@ The following example adds two products each in the Bags, Fitness Equipment, and ```json { - "products": [ - { - "sku": "24-MB01" - }, - { - "sku": "24-MB04" - }, - { - "sku": "24-UG06" - }, - { - "sku": "24-UG07" - }, - { - "sku": "24-MG04" - }, - { - "sku": "24-MG01" - } - ] + "products": [ + { + "sku": "24-MB01" + }, + { + "sku": "24-MB04" + }, + { + "sku": "24-UG06" + }, + { + "sku": "24-UG07" + }, + { + "sku": "24-MG04" + }, + { + "sku": "24-MG01" + } + ] } ``` @@ -205,9 +205,9 @@ Unassigning a product does not remove it from its category or categories. ```json { "products": [ - { - "sku": "24-MG01" - } + { + "sku": "24-MG01" + } ] } ``` diff --git a/guides/v2.2/cloud/basic-information/starter-architecture.md b/guides/v2.2/cloud/basic-information/starter-architecture.md index c5de72d5cdd..86d5f3cc6c7 100644 --- a/guides/v2.2/cloud/basic-information/starter-architecture.md +++ b/guides/v2.2/cloud/basic-information/starter-architecture.md @@ -74,10 +74,10 @@ The Production and Staging environments include the following technologies. You Each service runs in its own secure container. Containers are managed together in the project. Some services are built-in, such as the following: -* HTTP router (handling incoming requests, but also caching and redirects) -* PHP application server -* Git -* Secure Shell (SSH) +* HTTP router (handling incoming requests, but also caching and redirects) +* PHP application server +* Git +* Secure Shell (SSH) You can even have multiple applications running in the same project. Building a microservice oriented architecture with {{site.data.var.ee}} is as easy as managing a monolithic application. @@ -85,8 +85,8 @@ You can even have multiple applications running in the same project. Building a {{site.data.var.ece}} uses: -* Operating system: Debian GNU/Linux 8 (jessie) -* Web server: [nginx](https://glossary.magento.com/nginx) 1.8 +* Operating system: Debian GNU/Linux 8 (jessie) +* Web server: [nginx](https://glossary.magento.com/nginx) 1.8 You cannot upgrade the operating system and web server software to a new version, but you can configure versions for the following software: @@ -100,9 +100,9 @@ In the Staging and Production environments, you use Fastly for CDN and caching. You use the following files to configure the software versions that you want to use in your implementation. -* [`.magento.app.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_magento-app.html) -* [`routes.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_routes.html) -* [`services.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_services.html) +* [`.magento.app.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_magento-app.html) +* [`routes.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_routes.html) +* [`services.yaml`]({{ page.baseurl }}/cloud/project/project-conf-files_services.html) ### Backup and disaster recovery {#backup} diff --git a/guides/v2.2/cloud/before/before-setup-env-2_clone.md b/guides/v2.2/cloud/before/before-setup-env-2_clone.md index 333da5932a9..0e5e2482a68 100644 --- a/guides/v2.2/cloud/before/before-setup-env-2_clone.md +++ b/guides/v2.2/cloud/before/before-setup-env-2_clone.md @@ -132,7 +132,7 @@ Alternatively, you can add or update variables in the Project Web Interface. 1. Click the **Configure environment** gear icon ![Configure your environment]({{ site.baseurl }}/common/images/cloud_edit-project.png) 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) 1. Select the **Variables** tab. @@ -140,7 +140,7 @@ Alternatively, you can add or update variables in the Project Web Interface. 1. Enter the **Name** and **Value** for the variable. For example, enter `ADMIN_EMAIL` and your License Owner email address or another accessible email for resetting the password for the default admin account. - ![Project variable]({{ site.baseurl }}/common/images/cloud_project_variable.png) + ![Project variable]({{ site.baseurl }}/common/images/cloud_project_variable.png) 1. Click **Add variable**. After you add the variable, wait until deployment completes. diff --git a/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md b/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md index 5f66e3e13c4..b936ea886a4 100644 --- a/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md +++ b/guides/v2.2/cloud/before/before-workspace-file-sys-owner.md @@ -24,11 +24,11 @@ Create the Magento file system owner with a strong password. Magento file system To create the Magento file system owner, enter the following command as a user with `root` privileges: - adduser + adduser To give the user a password, enter the following command as a user with `root` privileges: - passwd + passwd Follow the prompts on your screen to create a password for the user. @@ -37,8 +37,8 @@ If you do not have `root` privileges on your Magento server, you can use another For example, to create a user named `magento_user` and give the user a password, enter: - sudo adduser magento_user - sudo passwd magento_user + sudo adduser magento_user + sudo passwd magento_user {: .bs-callout .bs-callout-warning} Because the point of creating this user is to provide added security, it is essential that you create a strong password. @@ -47,7 +47,7 @@ Because the point of creating this user is to provide added security, it is esse To find the web server user's group: -* CentOS: +* CentOS: ```bash grep -E -i '^user|^group' /etc/httpd/conf/httpd.conf @@ -58,33 +58,33 @@ To find the web server user's group: ``` Typically, the user and group name are both `apache` -* Ubuntu: `ps aux | grep apache` to find the apache user, then `groups ` to find the group +* Ubuntu: `ps aux | grep apache` to find the apache user, then `groups ` to find the group - Typically, the username and the group name are both `www-data` + Typically, the username and the group name are both `www-data` ## Put the Magento file system owner in the web server's primary group {#install-update-depend-user-add2group} Assuming the typical Apache group name for CentOS and Ubuntu, enter the following command as a user with `root` privileges: -* CentOS: `usermod -g apache ` -* Ubuntu: `usermod -g www-data ` +* CentOS: `usermod -g apache ` +* Ubuntu: `usermod -g www-data ` For example, to add the user `magento_user` to the `apache` primary group on CentOS: - usermod -g apache magento_user + usermod -g apache magento_user To confirm your Magento user is a member of the web server group, enter the following command: - groups + groups A sample result follows: - magento_user : apache + magento_user : apache To complete the task, restart the web server: -* Ubuntu: `service apache2 restart` -* CentOS: `service httpd restart` +* Ubuntu: `service apache2 restart` +* CentOS: `service httpd restart` #### Next step: [Clone and branch the project]({{ page.baseurl }}/cloud/before/before-setup-env-2_clone.html) diff --git a/guides/v2.2/cloud/before/before-workspace-magento-prereqs.md b/guides/v2.2/cloud/before/before-workspace-magento-prereqs.md index 06b5269aaae..e1387c169ab 100644 --- a/guides/v2.2/cloud/before/before-workspace-magento-prereqs.md +++ b/guides/v2.2/cloud/before/before-workspace-magento-prereqs.md @@ -36,9 +36,9 @@ When using Vagrant, we also recommend the package [hostmanager](https://github.c ## Development tools {#devtools} * [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - Provides code branching and management for accessing {{site.data.var.ee}} and your code repositories. Use Git command-line commands or applications of your choice to work with Git. You can install this on your local VM or on your host. - For more information, see [How Cloud uses Git]({{ page.baseurl }}/cloud/reference/git-integration.html). + For more information, see [How Cloud uses Git]({{ page.baseurl }}/cloud/reference/git-integration.html). * [Composer](https://getcomposer.org/download/) - Used for dependency management. Composer enables us to manage the Magento components and their dependencies. Install on your local VM. - For more information, see [How Cloud uses Composer]({{ page.baseurl }}/cloud/reference/cloud-composer.html). + For more information, see [How Cloud uses Composer]({{ page.baseurl }}/cloud/reference/cloud-composer.html). ## Web server (local) {#webserver} @@ -71,20 +71,20 @@ To set `memory_limit`: Before working with your {{site.data.var.ece}} project, set the PHP `memory_limit` to at least `1G` for normal use or at least `2G` for debugging. -1. Find your `php.ini` file using the following command: +1. Find your `php.ini` file using the following command: - php --ini + php --ini - Use the value of `Loaded Configuration File`. -2. As a user with `root` privileges, open `php.ini` in a text editor. -3. Change the value of `memory_limit` to at least `1G` for normal use or at least `2G` for debugging. -4. Save your changes to `php.ini` and exit the text editor. -5. Restart your web server: + Use the value of `Loaded Configuration File`. +2. As a user with `root` privileges, open `php.ini` in a text editor. +3. Change the value of `memory_limit` to at least `1G` for normal use or at least `2G` for debugging. +4. Save your changes to `php.ini` and exit the text editor. +5. Restart your web server: - * Apache: - * CentOS: `service httpd restart` - * Ubuntu: `service apache2 restart` - * Nginx: `service nginx restart` + * Apache: + * CentOS: `service httpd restart` + * Ubuntu: `service apache2 restart` + * Nginx: `service nginx restart` ## Database (local) {#database} @@ -99,27 +99,27 @@ These example instructions detail how to install and create a MariaDB database f 1. Use this command to create the database: - apt-get install mariadb-server + apt-get install mariadb-server 2. Secure the database with the following command and completing all prompts: - mysql_secure_installation + mysql_secure_installation 3. Access the MariaDB database. 4. Grant all privileges to the Magento account you created for the local: - grant all privileges on to ''@'localhost' identified by ''; + grant all privileges on to ''@'localhost' identified by ''; 5. Finally create the database: - create database magento; - use magento; + create database magento; + use magento; 6. Exit when done. ### Pro: Set up the auto-increment for MariaDB You need to set an auto-increment value for the MariaDB installation. -1. As a user with `root` privileges, open `/etc/mysql/mariadb.conf.d/50-server.cnf` in a text editor. -2. In the Basic Settings section, add `auto_increment_increment = 3`. -3. Restart the service: `service mysql restart`. +1. As a user with `root` privileges, open `/etc/mysql/mariadb.conf.d/50-server.cnf` in a text editor. +2. In the Basic Settings section, add `auto_increment_increment = 3`. +3. Restart the service: `service mysql restart`. ### Pro: Set up the auto-increment for MySQL {#cloud-mysql} @@ -129,24 +129,24 @@ To avoid issues, we recommend you set `auto_increment_increment=3`. First, view the current value and verify if it is set to 3: - mysqladmin variables -u -p | grep 'auto_increment' + mysqladmin variables -u -p | grep 'auto_increment' If necessary, set `auto_increment_increment` to 3: -1. As a user with `root` privileges, open `/etc/my.cnf` in a text editor. +1. As a user with `root` privileges, open `/etc/my.cnf` in a text editor. - {:.bs-callout .bs-callout-info} - On Ubuntu 16, the path is typically `/etc/mysql/mysql.conf.d/mysqld.cnf`. + {:.bs-callout .bs-callout-info} + On Ubuntu 16, the path is typically `/etc/mysql/mysql.conf.d/mysqld.cnf`. -2. Add or edit the following line in the `[mysqld]` section: +2. Add or edit the following line in the `[mysqld]` section: - auto_increment_increment=3 + auto_increment_increment=3 - {{site.data.var.ece}} supports a High Availability configuration. This setting increments the database IDs in increments of three to ensure row uniqueness for Galera databases on each of the three HA nodes in production. + {{site.data.var.ece}} supports a High Availability configuration. This setting increments the database IDs in increments of three to ensure row uniqueness for Galera databases on each of the three HA nodes in production. -3. Restart MySQL: +3. Restart MySQL: - service mysqld restart + service mysqld restart ## Magento Cloud CLI (local) {#cloud-ssh-cli-cli-install} @@ -156,31 +156,31 @@ These instructions discuss installation using commands for a Unix environment. F To install the Magento Cloud CLI: -1. Log in to your local development machine 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 machine 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](https://glossary.magento.com/magento-file-system-owner) has write access, such as the home directory. +2. Change to a directory to which the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner) has write access, such as the home directory. -3. Enter the following command: +3. Enter the following command: - curl -sS https://accounts.magento.cloud/cli/installer | php + curl -sS https://accounts.magento.cloud/cli/installer | php -4. After the CLI downloads, an operating system-specific command displays. +4. After the CLI downloads, an operating system-specific command displays. - For example, on Ubuntu and CentOS, the command is similar to: + For example, on Ubuntu and CentOS, the command is similar to: - source $HOME/.bashrc + source $HOME/.bashrc - For more information about the user shell profile, see [.bash_profile vs .bashrc](https://apple.stackexchange.com/questions/51036/what-is-the-difference-between-bash-profile-and-bashrc) + For more information about the user shell profile, see [.bash_profile vs .bashrc](https://apple.stackexchange.com/questions/51036/what-is-the-difference-between-bash-profile-and-bashrc) - You can also add the `$HOME/.magento-cloud/bin` to the Magento user's `PATH`: + You can also add the `$HOME/.magento-cloud/bin` to the Magento user's `PATH`: - export PATH=$PATH:$HOME/.magento-cloud/bin + export PATH=$PATH:$HOME/.magento-cloud/bin - Consult operating system documentation for details. + Consult operating system documentation for details. -5. Verify the `magento-cloud` command is in your path by entering the following command: +5. Verify the `magento-cloud` command is in your path by entering the following command: - magento-cloud list + magento-cloud list ## Additional requirements for Magento Commerce {#commerce} diff --git a/guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md b/guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md index a017ab43c27..845eaf2636a 100644 --- a/guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md +++ b/guides/v2.2/cloud/cdn/cloud-fastly-custom-response.md @@ -64,15 +64,15 @@ Verify that the modified source displays correctly in the browser. Then, add the ![Edit 503 error page] -1. Click **Set HTML**. +1. Click **Set HTML**. -1. Copy and paste the source code for your custom response page into the HTML field. +1. Copy and paste the source code for your custom response page into the HTML field. ![Update 503 error page] -1. Click **Upload** at the top of the page to upload the customized HTML source to the Fastly server. +1. Click **Upload** at the top of the page to upload the customized HTML source to the Fastly server. -1. Click **Save Config** at the top of the page to save the updated configuration file. +1. Click **Save Config** at the top of the page to save the updated configuration file. 1. Refresh the cache. @@ -131,9 +131,9 @@ The Edit WAF option is available only if the Managed Cloud WAF service is enable - **MIME type**—Type `text/html`. - **Content**—Edit the default HTML response to add custom CSS and update the title and messaging as needed. -1. Click **Upload** at the top of the page to upload the customized HTML source to the Fastly server. +1. Click **Upload** at the top of the page to upload the customized HTML source to the Fastly server. -1. Click **Save Config** at the top of the page to save the updated configuration file. +1. Click **Save Config** at the top of the page to save the updated configuration file. 1. Refresh the cache. diff --git a/guides/v2.2/cloud/cdn/configure-fastly.md b/guides/v2.2/cloud/cdn/configure-fastly.md index 26d2d43ffaa..bf2406bc70f 100644 --- a/guides/v2.2/cloud/cdn/configure-fastly.md +++ b/guides/v2.2/cloud/cdn/configure-fastly.md @@ -158,7 +158,7 @@ If you need to integrate additional backends into your site such as a backend to 1. Expand **Backend settings** and click the gear to check the default backend. A modal opens that shows current settings with options to change them. - ![Modify the backend]({{ site.baseurl }}/common/images/cloud_fastly-backend.png){:width="600px"} + ![Modify the backend]({{ site.baseurl }}/common/images/cloud_fastly-backend.png){:width="600px"} 1. Select the **Shield** location (or datacenter) closest to your AWS region. For example, if Staging is on the west coast of the United States @@ -278,7 +278,7 @@ provide a list of stores matching their obtained country code. If you already us 1. For **Country Mapping**, click **Add** to enter a two-letter country code to map with a specific Magento store from a list. For a list of country codes, see [this site](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). - ![Add GeoIP country maps]({{ site.baseurl }}/common/images/cloud_fastly-geo-code.png) + ![Add GeoIP country maps]({{ site.baseurl }}/common/images/cloud_fastly-geo-code.png) 1. Click **Save Config** at the top of the page. diff --git a/guides/v2.2/cloud/cdn/fastly-image-optimization.md b/guides/v2.2/cloud/cdn/fastly-image-optimization.md index 9ad958cc56c..d069589ea9b 100644 --- a/guides/v2.2/cloud/cdn/fastly-image-optimization.md +++ b/guides/v2.2/cloud/cdn/fastly-image-optimization.md @@ -101,11 +101,11 @@ You can review and update the default IO configuration settings for image optimi used to deliver a resized image. Depending on the filter selected the resized image can have a higher or lower number of pixels. - - `Lanczos3` (default)—Delivers the best quality image. It increases the ability to detect edges and linear features within an image and uses sinc resampling to provide the best possible reconstruction. - - `Lanczos2`—Uses same filter as `Lancsoz3` but with a less accurate approximation of the sinc resampling function. - - `Bicubic`—Has a natural sharpening effect when making an image smaller. - - `Bilinear`—Has a natural smoothing effect when making an image larger. - - `Nearest`—Has a natural pixelation effect when resizing pixel art. + - `Lanczos3` (default)—Delivers the best quality image. It increases the ability to detect edges and linear features within an image and uses sinc resampling to provide the best possible reconstruction. + - `Lanczos2`—Uses same filter as `Lancsoz3` but with a less accurate approximation of the sinc resampling function. + - `Bicubic`—Has a natural sharpening effect when making an image smaller. + - `Bilinear`—Has a natural smoothing effect when making an image larger. + - `Nearest`—Has a natural pixelation effect when resizing pixel art. 1. After you specify the IO configuration settings for the Fastly service, click **Cancel** to return to the Fastly configuration settings. diff --git a/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md b/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md index 0fdafa0e944..bb37024ce62 100644 --- a/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md +++ b/guides/v2.2/cloud/cdn/fastly-vcl-badreferer.md @@ -28,7 +28,7 @@ Edge Dictionaries create key-value pairs accessible to VCL functions during VCL {% include cloud/admin-ui-login-step.md %} -1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. +1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. 1. Expand **Full Page Cache** > **Fastly Configuration** > **Edge dictionaries**. @@ -94,7 +94,7 @@ Add the custom VCL snippet to your Fastly service configuration from the Magento {% include cloud/admin-ui-login-step.md %} -1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. +1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. 1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**. diff --git a/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md b/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md index 71e38bd2b2e..55c805595f6 100644 --- a/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md +++ b/guides/v2.2/cloud/cdn/fastly-vcl-whitelist.md @@ -99,13 +99,13 @@ Add the custom VCL snippet to your Fastly service configuration from the Magento - **Type**—`recv` - - **Priority**—`5` + - **Priority**—`5` - Add the **VCL** snippet content: - ``` - if ((req.url ~ "^/admin") && !(client.ip ~ allowlist) && !req.http.Fastly-FF) { error 403 "Forbidden"; - ``` + ``` + if ((req.url ~ "^/admin") && !(client.ip ~ allowlist) && !req.http.Fastly-FF) { error 403 "Forbidden"; + ``` 1. Click **Create** to generate the VCL snippet file with the name pattern `type_priority_name.vcl`, for example `recv_5_allowlist.vcl` diff --git a/guides/v2.2/cloud/cdn/fastly-vcl-wordpress.md b/guides/v2.2/cloud/cdn/fastly-vcl-wordpress.md index 070f2a45a1d..4095360124c 100644 --- a/guides/v2.2/cloud/cdn/fastly-vcl-wordpress.md +++ b/guides/v2.2/cloud/cdn/fastly-vcl-wordpress.md @@ -61,7 +61,7 @@ Edge Dictionaries create key-value pairs accessible to VCL functions during VCL - Add and save key-value pairs in the new dictionary. For this example, each **Key** is a URL path to redirect to the WordPress backend, and the **Value** is 1. - ![Add Edge Dictionary Items] + ![Add Edge Dictionary Items] - Click **Cancel** to return to the system configuration page. @@ -106,7 +106,7 @@ Add the custom VCL snippet to your Fastly service configuration from the Admin U {% include cloud/admin-ui-login-step.md %} -1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. +1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. 1. Expand **Full Page Cache** > **Fastly Configuration** > **Custom VCL Snippets**. @@ -114,20 +114,20 @@ Add the custom VCL snippet to your Fastly service configuration from the Admin U 1. Add the VCL snippet values: - - **Name**—`wordpress_redirect` + - **Name**—`wordpress_redirect` - - **Type**—`recv` + - **Type**—`recv` - - **Priority**—`5` + - **Priority**—`5` - - **VCL** snippet content: + - **VCL** snippet content: ``` if ( req.url.path ~ "^/?([^/?]+)") - { - if ( table.lookup(wordpress_urls, re.group.1, \"NOTFOUND\") != \"NOTFOUND\" ) - {set req.http.X-WP = "1"; - } + { + if ( table.lookup(wordpress_urls, re.group.1, \"NOTFOUND\") != \"NOTFOUND\" ) + {set req.http.X-WP = "1"; + } } ``` diff --git a/guides/v2.2/cloud/cdn/trouble-fastly.md b/guides/v2.2/cloud/cdn/trouble-fastly.md index 43458fdb42d..8d2655b5457 100644 --- a/guides/v2.2/cloud/cdn/trouble-fastly.md +++ b/guides/v2.2/cloud/cdn/trouble-fastly.md @@ -83,25 +83,25 @@ When a 503 error occurs, Fastly returns the reason on the error and maintenance {% include cloud/admin-ui-login-step.md %} -1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. +1. Click **Stores** > **Settings** > **Configuration** > **Advanced** > **System**. -1. In the right pane, expand **Full Page Cache**. +1. In the right pane, expand **Full Page Cache**. -1. In the **Fastly Configuration** section, expand **Custom Synthetic Pages** as the following figure shows. +1. In the **Fastly Configuration** section, expand **Custom Synthetic Pages** as the following figure shows. - ![Custom 503 error page] + ![Custom 503 error page] -1. Click **Set HTML**. +1. Click **Set HTML**. -1. Remove the custom code. You can save it in a text program to add back later. +1. Remove the custom code. You can save it in a text program to add back later. -1. Click **Upload** to send your updates to Fastly. +1. Click **Upload** to send your updates to Fastly. -1. Click **Save Config** at the top of the page. +1. Click **Save Config** at the top of the page. -1. Reopen the URL that caused the 503 error. Fastly returns an error page with the reason as shown in the following example. +1. Reopen the URL that caused the 503 error. Fastly returns an error page with the reason as shown in the following example. - ![Fastly error]({{ site.baseurl }}/common/images/cloud_fastly-503-example.png) + ![Fastly error]({{ site.baseurl }}/common/images/cloud_fastly-503-example.png) ## Apex and subdomains already associated with a Fastly account {#domains} @@ -129,7 +129,7 @@ Fastly API requests are passed through the Fastly extension to get a response fr curl https:// -vo /dev/null -H Fastly-Debug:1 ``` - If you have not set a static route or completed the DNS configuration for the domains on your live site, use the `--resolve` flag, which bypasses DNS name resolution. + If you have not set a static route or completed the DNS configuration for the domains on your live site, use the `--resolve` flag, which bypasses DNS name resolution. ```bash curl https:// -vo /dev/null -H Fastly-Debug:1 [--resolve] :443: @@ -210,31 +210,31 @@ The following excerpt from the cURL command output shows the correct values for * Added connection 0. The cache now contains 1 members * Trying 192.0.2.31... * STATE: CONNECT => WAITCONNECT handle 0x600057800; line 1455 (connection #0) - % Total % Received % Xferd Average Speed Time Time Time Current + % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed - 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0* Connected to www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud (54.229.163.31) port 443 (#0) + 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0* Connected to www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud (54.229.163.31) port 443 (#0) * STATE: WAITCONNECT => SENDPROTOCONNECT handle 0x600057800; line 1562 (connection #0) 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0* ALPN, offering h2 - ... portion omitted for brevity ... - - < Set-Cookie: mage-messages=%5B%5D; expires=Wed, 22-Nov-2017 17:39:58 GMT; Max-Age=31536000; path=/ - < Pragma: cache - < Expires: Wed, 23 Nov 2016 17:39:56 GMT - < Cache-Control: max-age=86400, public, s-maxage=86400, stale-if-error=5, stale-while-revalidate=5 - < X-Magento-Tags: cb_welcome_popup store cb cb_store_info_mobile cb_header_promotional_bar cb_store_info cb_discount-promo-bar cpg_2 cb_83 cb_81 cb_84 cb_85 cb_86 cb_87 cb_88 cb_89 p5646 catalog_product p5915 p6040 p6197 p6227 p7095 p6109 p6122 p6331 p7592 p7651 p7690 - < Fastly-Module-Enabled: yes - < Strict-Transport-Security: max-age=31536000 - < Content-Security-Policy: upgrade-insecure-requests - < X-Content-Type-Options: nosniff - < X-XSS-Protection: 1; mode=block - < X-Frame-Options: SAMEORIGIN - < X-Platform-Server: i-dff64b52 - < - * STATE: PERFORM => DONE handle 0x600057800; line 1955 (connection #0) - * multi_done - 0 0 0 0 0 0 0 0 --:--:-- 0:00:02 --:--:-- 0 - * Connection #0 to host www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud left intact + ... portion omitted for brevity ... + + < Set-Cookie: mage-messages=%5B%5D; expires=Wed, 22-Nov-2017 17:39:58 GMT; Max-Age=31536000; path=/ + < Pragma: cache + < Expires: Wed, 23 Nov 2016 17:39:56 GMT + < Cache-Control: max-age=86400, public, s-maxage=86400, stale-if-error=5, stale-while-revalidate=5 + < X-Magento-Tags: cb_welcome_popup store cb cb_store_info_mobile cb_header_promotional_bar cb_store_info cb_discount-promo-bar cpg_2 cb_83 cb_81 cb_84 cb_85 cb_86 cb_87 cb_88 cb_89 p5646 catalog_product p5915 p6040 p6197 p6227 p7095 p6109 p6122 p6331 p7592 p7651 p7690 + < Fastly-Module-Enabled: yes + < Strict-Transport-Security: max-age=31536000 + < Content-Security-Policy: upgrade-insecure-requests + < X-Content-Type-Options: nosniff + < X-XSS-Protection: 1; mode=block + < X-Frame-Options: SAMEORIGIN + < X-Platform-Server: i-dff64b52 + < + * STATE: PERFORM => DONE handle 0x600057800; line 1955 (connection #0) + * multi_done + 0 0 0 0 0 0 0 0 --:--:-- 0:00:02 --:--:-- 0 + * Connection #0 to host www.mymagento.biz.c.sv7gVom4qrpek.ent.magento.cloud left intact ``` {:.bs-callout .bs-callout-info} @@ -278,9 +278,9 @@ If the `X-Cache` header is `MISS, MISS` and does not contain `HIT`, run the `cur If you get the same result, use the [`curl` commands](#curl) and verify the [response headers](#response-headers): -* `Pragma` is `cache` -* `X-Magento-Tags` exists -* `Cache-Control: max-age` is greater than 0 +* `Pragma` is `cache` +* `X-Magento-Tags` exists +* `Cache-Control: max-age` is greater than 0 If the issue persists, another extension is likely resetting these headers. Repeat the following procedure in the Staging environment, disabling all extensions and re-enabling each one to determine which extension is resetting the headers. After you identify the extension causing the problem, you must disable it in the Production environment. diff --git a/guides/v2.2/cloud/configure/import-url-rewrites.md b/guides/v2.2/cloud/configure/import-url-rewrites.md index 40bb237dfac..82db32023d9 100644 --- a/guides/v2.2/cloud/configure/import-url-rewrites.md +++ b/guides/v2.2/cloud/configure/import-url-rewrites.md @@ -89,10 +89,10 @@ You use the Magento Admin panel to import the URL Rewrites file. 1. Click **Import**. The import task begins with the following message: - ![Task scheduled URL rewrite]({{site.baseurl}}/common/images/cloud-urlrewrite-task.png) + ![Task scheduled URL rewrite]({{site.baseurl}}/common/images/cloud-urlrewrite-task.png) A successful import returns the following message: - ![Successful URL rewrite]({{site.baseurl}}/common/images/cloud-urlrewrite-success.png) + ![Successful URL rewrite]({{site.baseurl}}/common/images/cloud-urlrewrite-success.png) ## Troubleshooting the import diff --git a/guides/v2.2/cloud/env/environments-ssh.md b/guides/v2.2/cloud/env/environments-ssh.md index e83a3f2c52d..9fb2d40741c 100644 --- a/guides/v2.2/cloud/env/environments-ssh.md +++ b/guides/v2.2/cloud/env/environments-ssh.md @@ -47,18 +47,18 @@ Magento Cloud CLI commands can only be used in environments with the software in To SSH to an environment using the Magento Cloud command line: -1. Log in to the project: +1. Log in to the project: - magento-cloud login -2. List the project IDs: + magento-cloud login +2. List the project IDs: - magento-cloud project:list -3. List the environments in that project: + magento-cloud project:list +3. List the environments in that project: - magento-cloud environment:list -p -3. SSH to the environment: + magento-cloud environment:list -p +3. SSH to the environment: - magento-cloud ssh -p -e + magento-cloud ssh -p -e ### Locate the SSH command in the Project Web Interface {#web-interface} @@ -66,18 +66,18 @@ You can locate the SSH command for all Starter environments and Pro Integration To copy the SSH command: -1. Log in to the Project Web Interface. -2. Select an environment or branch to access. -3. Click **Access Site**. +1. Log in to the Project Web Interface. +2. Select an environment or branch to access. +3. Click **Access Site**. - ![Find the SSH URL using the Web Interface]({{ site.baseurl }}/common/images/cloud_project-access-starter.png) + ![Find the SSH URL using the Web Interface]({{ site.baseurl }}/common/images/cloud_project-access-starter.png) -4. Click the clipboard button to copy the full SSH command to the clipboard. -5. Enter the command in a terminal window to SSH. +4. Click the clipboard button to copy the full SSH command to the clipboard. +5. Enter the command in a terminal window to SSH. Example SSH command: - ssh abcdefg123abc-smith-a12b34c--mymagento@ssh.us-2.magento.cloud + ssh abcdefg123abc-smith-a12b34c--mymagento@ssh.us-2.magento.cloud ### SSH commands for Pro Staging and Production {#pro} @@ -87,8 +87,8 @@ With your SSH keys added to those servers, you can use a terminal application, t For the URLs, see the following: -* Staging: `ssh _stg@.ent.magento.cloud` -* Production: `ssh @.ent.magento.cloud` +* Staging: `ssh _stg@.ent.magento.cloud` +* Production: `ssh @.ent.magento.cloud` For example, to log in to the Staging environment, use the following command: `ssh abcdefghij_stg@abcdefghij.ent.magento.cloud`. For production: `ssh abcdefghij@abcdefghij.ent.magento.cloud` diff --git a/guides/v2.2/cloud/env/set-variables.md b/guides/v2.2/cloud/env/set-variables.md index 431a39909f9..3ee20a37cf1 100644 --- a/guides/v2.2/cloud/env/set-variables.md +++ b/guides/v2.2/cloud/env/set-variables.md @@ -59,7 +59,7 @@ Optional: You can also create an environment and list the environment variables. After the environment deploys, enter - magento-cloud variable:get -e + magento-cloud variable:get -e A sample result follows: diff --git a/guides/v2.2/cloud/howtos/custom-theme.md b/guides/v2.2/cloud/howtos/custom-theme.md index 9793e576a33..e7520890ae1 100644 --- a/guides/v2.2/cloud/howtos/custom-theme.md +++ b/guides/v2.2/cloud/howtos/custom-theme.md @@ -41,7 +41,7 @@ To install a theme manually, you must have the theme's code, either in a compres To install a theme manually: -1. Copy the theme's code under `/app/design/frontend` for a storefront theme or `/app/design/adminhtml` for an Admin theme. Verify that the top-level directory is ``; otherwise, the theme will not install properly. +1. Copy the theme's code under `/app/design/frontend` for a storefront theme or `/app/design/adminhtml` for an Admin theme. Verify that the top-level directory is ``; otherwise, the theme will not install properly. For example: @@ -54,17 +54,17 @@ To install a theme manually: A sample follows: ExampleTheme Magento -3. Add and commit files: +3. Add and commit files: - git add -A && git commit -m "Add theme" -4. Push the files to your branch: + git add -A && git commit -m "Add theme" +4. Push the files to your branch: - git push origin -5. Wait for deployment to complete. -6. Log in to the Magento Admin. -7. Click **Content** > Design > **Themes**. + git push origin +5. Wait for deployment to complete. +6. Log in to the Magento Admin. +7. Click **Content** > Design > **Themes**. - The theme displays in the right pane. + The theme displays in the right pane. ## Install a theme using Composer {#composer} diff --git a/guides/v2.2/cloud/howtos/debug.md b/guides/v2.2/cloud/howtos/debug.md index 27f8ebd3a6e..459e3efbce9 100644 --- a/guides/v2.2/cloud/howtos/debug.md +++ b/guides/v2.2/cloud/howtos/debug.md @@ -48,8 +48,8 @@ You can enable Xdebug directly to all Starter environments and Pro Integration e 1. In your local terminal, open `.magento.app.yaml` in a text editor. 2. In the `runtime` section, under `extensions`, add `xdebug`. For example: - runtime: - extensions: + runtime: + extensions: - mcrypt - redis - xsl @@ -68,9 +68,9 @@ You can enable Xdebug directly to all Starter environments and Pro Integration e 4. Save your changes to `.magento.app.yaml` and exit the text editor. 5. Add, commit, and push the changes to redeploy the environment: - git add -A - git commit -m "Add xdebug" - git push origin + git add -A + git commit -m "Add xdebug" + git push origin When deployed to Starter environments and Pro Integration environments, Xdebug is now available. You should continue configuring your IDE. For PhpStorm, see [Configure PhpStorm](#phpstorm). @@ -106,8 +106,8 @@ You need to set up port forwarding. This is necessary to map the XDEBUG connecti To do any type of debugging, you must forward port 9000 from your {{site.data.var.ece}} server to your local machine. See one of the following sections: -* [Port forwarding on Mac or UNIX](#portmac) -* [Port forwarding on Windows](#portwindows) +* [Port forwarding on Mac or UNIX](#portmac) +* [Port forwarding on Windows](#portwindows) #### Port forwarding on Mac or UNIX {#portmac} @@ -124,15 +124,15 @@ If an "unable to connect" or "could not listen to port on remote" error is displ To troubleshoot the connection: -1. [SSH]({{ page.baseurl }}/cloud/env/environments-ssh.html) to the integration, staging, or production server. -2. Enter `who` to view a list of SSH sessions. -3. View existing SSH sessions by user. Be careful to not affect a user other than yourself! +1. [SSH]({{ page.baseurl }}/cloud/env/environments-ssh.html) to the integration, staging, or production server. +2. Enter `who` to view a list of SSH sessions. +3. View existing SSH sessions by user. Be careful to not affect a user other than yourself! - * Integration: usernames are similar to `dd2q5ct7mhgus` - * Staging: usernames are similar to `dd2q5ct7mhgus_stg` - * Production: usernames are similar to `dd2q5ct7mhgus` -4. For a user session that is older than yours, find the pseudo-terminal (PTS) value. For example, `pts/0`. -5. Kill the process ID (PID) corresponding to the PTS value using the following commands: + * Integration: usernames are similar to `dd2q5ct7mhgus` + * Staging: usernames are similar to `dd2q5ct7mhgus_stg` + * Production: usernames are similar to `dd2q5ct7mhgus` +4. For a user session that is older than yours, find the pseudo-terminal (PTS) value. For example, `pts/0`. +5. Kill the process ID (PID) corresponding to the PTS value using the following commands: ps aux | grep ssh kill @@ -151,35 +151,35 @@ To set up port forwarding (SSH tunneling) on Windows, you must configure your Wi To set up an SSH tunnel on Windows using Putty: -1. If you have not already done so, download [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). -2. Start Putty. -3. In the Category pane, click **Session**. -4. Enter the following information: +1. If you have not already done so, download [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). +2. Start Putty. +3. In the Category pane, click **Session**. +4. Enter the following information: - * **Hostname (or IP address)** field: Enter your Cloud server's [SSH URL]({{ page.baseurl }}/cloud/env/environments-ssh.html) - * **Port** field: Enter `22` + * **Hostname (or IP address)** field: Enter your Cloud server's [SSH URL]({{ page.baseurl }}/cloud/env/environments-ssh.html) + * **Port** field: Enter `22` ![Set up Putty]({{ site.baseurl }}/common/images/cloud-xdebug_putty-session.png){:width="350px"} -3. In the Category pane, click **Connection** > **SSH** > **Tunnels**. -4. Enter the following information: +3. In the Category pane, click **Connection** > **SSH** > **Tunnels**. +4. Enter the following information: - * **Source port** field: Enter `9000` - * **Destination** field: Enter `127.0.0.1:9000` - * Click **Remote** -5. Click **Add**. + * **Source port** field: Enter `9000` + * **Destination** field: Enter `127.0.0.1:9000` + * Click **Remote** +5. Click **Add**. ![Create an SSH tunnel in Putty]({{ site.baseurl }}/common/images/cloud-xdebug_putty-tunnels.png){:width="350px"} -6. In the Category pane, click **Session**. -7. In the **Saved Sessions** field, enter a name for this SSH tunnel. -8. Click **Save**. +6. In the Category pane, click **Session**. +7. In the **Saved Sessions** field, enter a name for this SSH tunnel. +8. Click **Save**. ![Save your SSH tunnel]({{ site.baseurl }}/common/images/cloud-xdebug_putty-session-save.png){:width="350px"} -9. To test the SSH tunnel, click **Load**, then click **Open**. +9. To test the SSH tunnel, click **Load**, then click **Open**. If an "unable to connect" error displays, verify all of the following: -* All Putty settings are correct -* You are running Putty on the machine on which your private {{site.data.var.ece}} SSH keys are located +* All Putty settings are correct +* You are running Putty on the machine on which your private {{site.data.var.ece}} SSH keys are located ### Configure Pro Staging and Production {#pro} @@ -193,15 +193,15 @@ For initiating debugging, performing setup, and more, you need the SSH commands For Starter environments and Pro Integration environments, you can use the following Magento Cloud CLI command to SSH into those environments: - magento-cloud environment:ssh --pipe -e + magento-cloud environment:ssh --pipe -e To use Xdebug, SSH to the environment as follows: - ssh -R :: + ssh -R :: For example, - ssh -R 9000:localhost:9000 pwga8A0bhuk7o-mybranch@ssh.us.magentosite.cloud + ssh -R 9000:localhost:9000 pwga8A0bhuk7o-mybranch@ssh.us.magentosite.cloud ## Debug for Pro Staging and Production {#pro-debug} @@ -267,22 +267,22 @@ This section discusses how to use Xdebug in Chrome using the Xdebug Helper exten To use Xdebug Helper with Chrome: -1. Create an [SSH tunnel](#ssh) to the Cloud server. -2. Install the [Xdebug Helper extension](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc?hl=en) from the Chrome store. -3. Enable the extension in Chrome as shown in the following figure. +1. Create an [SSH tunnel](#ssh) to the Cloud server. +2. Install the [Xdebug Helper extension](https://chrome.google.com/webstore/detail/xdebug-helper/eadndfjplgieldjbigjakmdgkmoaaaoc?hl=en) from the Chrome store. +3. Enable the extension in Chrome as shown in the following figure. - ![Enable the Xdebug extension in Chrome]({{ site.baseurl }}/common/images/install_docker_php-storm_xdebug-chrome.png) -4. In Chrome, right-click ![Xdebug helper icon]({{ site.baseurl }}/common/images/cloud-xdebug_helper-icon.png){:width="25px"} in the Chrome toolbar. -5. From the pop-up menu, click **Options**. -6. From the **IDE Key** list, click **PhpStorm**. -7. Click **Save**. + ![Enable the Xdebug extension in Chrome]({{ site.baseurl }}/common/images/install_docker_php-storm_xdebug-chrome.png) +4. In Chrome, right-click ![Xdebug helper icon]({{ site.baseurl }}/common/images/cloud-xdebug_helper-icon.png){:width="25px"} in the Chrome toolbar. +5. From the pop-up menu, click **Options**. +6. From the **IDE Key** list, click **PhpStorm**. +7. Click **Save**. - ![Xdebug Helper options]({{ site.baseurl }}/common/images/cloud-xdebug_helper-options.png){:width="400px"} -8. Open your PhpStorm project. -9. In the top navigation bar, click ![Start listening for connections]({{ site.baseurl }}/common/images/install_docker_php-storm_xdebug-start-listening.png){:width="25px"} (**Start listening**). + ![Xdebug Helper options]({{ site.baseurl }}/common/images/cloud-xdebug_helper-options.png){:width="400px"} +8. Open your PhpStorm project. +9. In the top navigation bar, click ![Start listening for connections]({{ site.baseurl }}/common/images/install_docker_php-storm_xdebug-start-listening.png){:width="25px"} (**Start listening**). - If the navigation bar isn't displayed, click **View** > **Navigation Bar**. -10. In the PhpStorm navigation pane, double-click the PHP file to test. + If the navigation bar isn't displayed, click **View** > **Navigation Bar**. +10. In the PhpStorm navigation pane, double-click the PHP file to test. ## Debug code locally {#code} @@ -290,32 +290,32 @@ Due to your environments being read-only, you need to pull code locally from an The method you choose is up to you. You have the following options: -* Check out code from Git and run `composer install` +* Check out code from Git and run `composer install` - This method works unless `composer.json` references packages in private repositories to which you do not have access. This method results in getting the entire Magento codebase. + This method works unless `composer.json` references packages in private repositories to which you do not have access. This method results in getting the entire Magento codebase. -* Copy the `vendor`, `app`, `pub`, `lib`, and `setup` directories +* Copy the `vendor`, `app`, `pub`, `lib`, and `setup` directories - This method results in your having all code you can possibly test. Depending on how many static assets you have, it could result in a long transfer with a large volume of files. -* Copy the `vendor` directory only + This method results in your having all code you can possibly test. Depending on how many static assets you have, it could result in a long transfer with a large volume of files. +* Copy the `vendor` directory only - Because most Magento and third-party code is in the `vendor` directory, this method is likely to result in good testing although you won't be testing the entire codebase. + Because most Magento and third-party code is in the `vendor` directory, this method is likely to result in good testing although you won't be testing the entire codebase. To compress files and copy them to your local machine: -1. SSH to the environment. -3. Enter the following command: +1. SSH to the environment. +3. Enter the following command: - tar -czf /tmp/.tgz + tar -czf /tmp/.tgz - For example, to compress the `vendor` directory only, enter + For example, to compress the `vendor` directory only, enter - tar -czf /tmp/vendor.tgz vendor -4. On your local environment with PhpStorm, enter the following commands: + tar -czf /tmp/vendor.tgz vendor +4. On your local environment with PhpStorm, enter the following commands: - cd - rsync :/tmp/.tgz . - tar xzf .tgz + cd + rsync :/tmp/.tgz . + tar xzf .tgz ## Troubleshooting Xdebug {#trouble} @@ -323,15 +323,15 @@ If you you suspend your laptop (like closing your lid on a Mac), then your SSH s Due to not having access to manually restart the nginx server, you need to locate and terminate SSH processes that haven't timed out yet. -1. [SSH]({{ page.baseurl }}/cloud/env/environments-ssh.html) to the integration, staging, or production server. -2. Enter `who` to view a list of SSH sessions. -3. View existing SSH sessions by user. Be careful to not affect a user other than yourself! +1. [SSH]({{ page.baseurl }}/cloud/env/environments-ssh.html) to the integration, staging, or production server. +2. Enter `who` to view a list of SSH sessions. +3. View existing SSH sessions by user. Be careful to not affect a user other than yourself! - * Integration: usernames are similar to `dd2q5ct7mhgus` - * Staging: usernames are similar to `dd2q5ct7mhgus_stg` - * Production: usernames are similar to `dd2q5ct7mhgus` -4. For a user session that is older than yours, find the pseudo-terminal (PTS) value. For example, `pts/0`. -5. Kill the process ID (PID) corresponding to the PTS value using the following commands: + * Integration: usernames are similar to `dd2q5ct7mhgus` + * Staging: usernames are similar to `dd2q5ct7mhgus_stg` + * Production: usernames are similar to `dd2q5ct7mhgus` +4. For a user session that is older than yours, find the pseudo-terminal (PTS) value. For example, `pts/0`. +5. Kill the process ID (PID) corresponding to the PTS value using the following commands: ps aux | grep ssh kill diff --git a/guides/v2.2/cloud/howtos/environment-tutorial-env-merge.md b/guides/v2.2/cloud/howtos/environment-tutorial-env-merge.md index 2186f9d9647..16898e6b3f0 100644 --- a/guides/v2.2/cloud/howtos/environment-tutorial-env-merge.md +++ b/guides/v2.2/cloud/howtos/environment-tutorial-env-merge.md @@ -27,25 +27,25 @@ To get started: To merge an environment: -1. Add a file named `test.txt` to the environment root directory. +1. Add a file named `test.txt` to the environment root directory. - You can put whatever contents you want; for example, the number `1` -7. Save your changes and exit the text editor. -8. Add, commit, and push your change to the environment: + You can put whatever contents you want; for example, the number `1` +7. Save your changes and exit the text editor. +8. Add, commit, and push your change to the environment: - git add -A - git commit -m "" - git push origin + git add -A + git commit -m "" + git push origin - Where `` is the Git name of the environment (that is, the environment ID). + Where `` is the Git name of the environment (that is, the environment ID). -9. Merge with the parent environment: +9. Merge with the parent environment: - magento-cloud environment:merge + magento-cloud environment:merge - For example, + For example, - magento-cloud environment:merge master + magento-cloud environment:merge master ## Optionally delete the environment {#tut-env-delete} @@ -58,44 +58,44 @@ You must be a [project administrator]({{ page.baseurl }}/cloud/project/user-admi This section discusses how to optionally delete an environment in the following ways: -* Make the environment *inactive* but let it remain in the project -* Delete the environment entirely and remove it from the project +* Make the environment *inactive* but let it remain in the project +* Delete the environment entirely and remove it from the project To delete a environment: -1. Log in to your project if you haven't already done so. -2. Fetch branches from the origin server. +1. Log in to your project if you haven't already done so. +2. Fetch branches from the origin server. - git fetch origin -2. To delete the branch entirely (removing it from the project), check out the branch. + git fetch origin +2. To delete the branch entirely (removing it from the project), check out the branch. - magento-cloud environment:checkout -2. Delete the environment: + magento-cloud environment:checkout +2. Delete the environment: - magento-cloud environment:delete + magento-cloud environment:delete - For example, to delete the `deleteme` environment: + For example, to delete the `deleteme` environment: - magento-cloud environment:delete deleteme + magento-cloud environment:delete deleteme - To delete more than one environment: + To delete more than one environment: - magento-cloud environment:delete + magento-cloud environment:delete - For additional options, see the command-line help: + For additional options, see the command-line help: - magento-cloud environment:delete --help + magento-cloud environment:delete --help -3. Answer the prompt: +3. Answer the prompt: - Are you sure you want to delete the remote Git branch deleteme? [Y/n] + Are you sure you want to delete the remote Git branch deleteme? [Y/n] - A `Y` answer makes the branch inactive but leaves it in the project. -5. Answer the prompt: + A `Y` answer makes the branch inactive but leaves it in the project. +5. Answer the prompt: - Delete the remote Git branch too? [Y/n] + Delete the remote Git branch too? [Y/n] - A `Y` answer completely removes the branch from the project. + A `Y` answer completely removes the branch from the project. Wait for the environment to delete. diff --git a/guides/v2.2/cloud/howtos/how-to.md b/guides/v2.2/cloud/howtos/how-to.md index 25ea1076aa9..49fa77e8bd2 100644 --- a/guides/v2.2/cloud/howtos/how-to.md +++ b/guides/v2.2/cloud/howtos/how-to.md @@ -17,13 +17,13 @@ Have suggestions? Open [an issue](https://github.com/magento/devdocs/issues) or Current topics: -* Install components, upgrade, update +* Install components, upgrade, update - * [Install, manage, and upgrade modules]({{ page.baseurl }}/cloud/howtos/install-components.html) - * [Test a Magento patch before deploying it]({{ page.baseurl }}/cloud/project/project-upgrade.html) + * [Install, manage, and upgrade modules]({{ page.baseurl }}/cloud/howtos/install-components.html) + * [Test a Magento patch before deploying it]({{ page.baseurl }}/cloud/project/project-upgrade.html) -* Environments +* Environments - * [Merge and delete an environment]({{ page.baseurl }}/cloud/howtos/environment-tutorial-env-merge.html) + * [Merge and delete an environment]({{ page.baseurl }}/cloud/howtos/environment-tutorial-env-merge.html) -* [Install optional sample data]({{ page.baseurl }}/cloud/howtos/sample-data.html) +* [Install optional sample data]({{ page.baseurl }}/cloud/howtos/sample-data.html) diff --git a/guides/v2.2/cloud/howtos/sample-data.md b/guides/v2.2/cloud/howtos/sample-data.md index f9d6a8bd733..e235aa655e9 100644 --- a/guides/v2.2/cloud/howtos/sample-data.md +++ b/guides/v2.2/cloud/howtos/sample-data.md @@ -24,15 +24,15 @@ We recommend working in a branch to add the sample data. The following informati To install sample data: -1. If you have not done so already, check out the environment in which to install sample data. -2. In a terminal, enter the following commands: +1. If you have not done so already, check out the environment in which to install sample data. +2. In a terminal, enter the following commands: ```bash /bin/magento sampledata:deploy ``` -3. Wait for components to update. -4. Commit and push the changes: +3. Wait for components to update. +4. Commit and push the changes: ```bash git add -A && git commit -m "Install sample data" @@ -42,9 +42,9 @@ To install sample data: git push origin ``` -5. Wait for the project to deploy. -6. Verify the installation was successful by going to your storefront main page in the Integration environment. You can locate the URL link to the storefront through the Project Web Interface. -7. Take a snapshot of your environment: +5. Wait for the project to deploy. +6. Verify the installation was successful by going to your storefront main page in the Integration environment. You can locate the URL link to the storefront through the Project Web Interface. +7. Take a snapshot of your environment: ```bash magento-cloud snapshot:create -e diff --git a/guides/v2.2/cloud/live/go-live-checklist.md b/guides/v2.2/cloud/live/go-live-checklist.md index 69d7ec328c7..b19a3eb6e9f 100644 --- a/guides/v2.2/cloud/live/go-live-checklist.md +++ b/guides/v2.2/cloud/live/go-live-checklist.md @@ -31,11 +31,11 @@ This does not work for an [apex domain](https://blog.cloudflare.com/zone-apex-na The following list contains examples of DNS providers for informational purposes. Use your preferred DNS provider. -* CNAME with ALIAS record from [Dyn](http://dyn.com) -* ANAME record on [DNS Made Easy](http://www.dnsmadeeasy.com) -* ANAME at [easyDNS](https://www.easydns.com) -* ACNAME at [CloudFlare](https://www.cloudflare.com) -* ALIAS at [PointDNS](https://pointhq.com) +* CNAME with ALIAS record from [Dyn](http://dyn.com) +* ANAME record on [DNS Made Easy](http://www.dnsmadeeasy.com) +* ANAME at [easyDNS](https://www.easydns.com) +* ACNAME at [CloudFlare](https://www.cloudflare.com) +* ALIAS at [PointDNS](https://pointhq.com) Many other DNS providers also offer workarounds to accomplish this goal. The most common is to add a CNAME record for the `www` host on the domain and then use the DNS provider's redirect service to redirect the apex over to the `www` version of the domain. Consult your DNS provider for more information. @@ -57,21 +57,21 @@ Make a final pass for any Production configurations in the store(s). If you need The following are recommended changes and checks: -* Outgoing email has been tested -* Base URL and Base Admin URL are set correctly -* Change the default Magento Admin password +* Outgoing email has been tested +* Base URL and Base Admin URL are set correctly +* Change the default Magento Admin password - See [Configuring Admin Security](http://docs.magento.com/m2/ee/user_guide/stores/security-admin.html) for further information on Admin configurations. -* Optimize all images for the web -* [Enable minification](http://docs.magento.com/m2/ee/user_guide/system/file-optimization.html) for JS, CSS, and HTTP + See [Configuring Admin Security](http://docs.magento.com/m2/ee/user_guide/stores/security-admin.html) for further information on Admin configurations. +* Optimize all images for the web +* [Enable minification](http://docs.magento.com/m2/ee/user_guide/system/file-optimization.html) for JS, CSS, and HTTP ## Verify Fastly caching {#verifyfastly} Test and verify Fastly caching is correctly working in Production. For detailed tests and checks, see [Fastly testing]({{ page.baseurl }}/cloud/live/stage-prod-test.html#fastly). -* Make sure that pages are being correctly cached in the page cache and Fastly -* Make sure the Fastly Extension is up-to-date -* Make sure the Fastly VCL is up-to-date +* Make sure that pages are being correctly cached in the page cache and Fastly +* Make sure the Fastly Extension is up-to-date +* Make sure the Fastly VCL is up-to-date ## Performance testing {#performance} diff --git a/guides/v2.2/cloud/live/live-prot.md b/guides/v2.2/cloud/live/live-prot.md index eada5d6beae..9146d1442b5 100644 --- a/guides/v2.2/cloud/live/live-prot.md +++ b/guides/v2.2/cloud/live/live-prot.md @@ -27,13 +27,13 @@ If a critical vulnerability is detected in your application, it rejects the Git We run two types of blocks: -* For development websites, we run complete blocks. +* For development websites, we run complete blocks. - The error message accompanying `git push` provides detailed information about the vulnerability. + The error message accompanying `git push` provides detailed information about the vulnerability. -* For production websites, we run a "partial block" that allows the site to stay mostly online. +* For production websites, we run a "partial block" that allows the site to stay mostly online. - Depending on the nature of the vulnerability, parts of a request, such as a query string, cookies or any additional headers, might be removed from GET requests. All other requests may be blocked entirely—this could apply to logging in, form submission, or product [checkout](https://glossary.magento.com/checkout). + Depending on the nature of the vulnerability, parts of a request, such as a query string, cookies or any additional headers, might be removed from GET requests. All other requests may be blocked entirely—this could apply to logging in, form submission, or product [checkout](https://glossary.magento.com/checkout). Unblocking is automated upon resolution of the security risk. The block is removed soon after you apply a security upgrade that removes the vulnerability. diff --git a/guides/v2.2/cloud/live/live-sanity-check.md b/guides/v2.2/cloud/live/live-sanity-check.md index 82f66ee1a87..068643c0326 100644 --- a/guides/v2.2/cloud/live/live-sanity-check.md +++ b/guides/v2.2/cloud/live/live-sanity-check.md @@ -80,10 +80,10 @@ Before you continue, push all current code to the remote Cloud server so that, i During the [build phase]({{page.baseurl}}/cloud/reference/discover-deploy.html#cloud-deploy-over-phases-build), we perform the following tasks: -* Apply patches distributed to all {{site.data.var.ece}} accounts -* Apply patches we provided specifically to you -* Enable modules to build -* Compile code and the [dependency injection](https://glossary.magento.com/dependency-injection) configuration +* Apply patches distributed to all {{site.data.var.ece}} accounts +* Apply patches we provided specifically to you +* Enable modules to build +* Compile code and the [dependency injection](https://glossary.magento.com/dependency-injection) configuration The build also checks for a [configuration file]({{ page.baseurl }}/cloud/live/sens-data-over.html). If the file exists, the static file deployment is also completed during the build stage. If not, it is completed in the deployment stage. @@ -91,38 +91,38 @@ Before you continue, you must know the file system path to any patch we provided #### To build your site: -1. Apply patches distributed to all {{site.data.var.ece}} accounts. +1. Apply patches distributed to all {{site.data.var.ece}} accounts. - Enter the following command from the project root directory: + Enter the following command from the project root directory: - php vendor/magento/magento-cloud-configuration/patch.php + php vendor/magento/magento-cloud-configuration/patch.php - Output includes the following: + Output includes the following: - [2016-11-30 15:05:15] Copying static.php to front-static.php - [2016-11-30 15:05:15] Command:git apply /var/www/html/magento2/vendor/magento/magento-cloud-configuration/patches/000-MAGETWO-57719-2.1.2.patch - [2016-11-30 15:05:15] Status:0 - [2016-11-30 15:05:15] Output:array ( - ) - [2016-11-30 15:05:15] Command:git apply /var/www/html/magento2/vendor/magento/magento-cloud-configuration/patches/MAGETWO-52660-scd-improvement.patch - [2016-11-30 15:05:15] Status:0 - [2016-11-30 15:05:15] Output:array ( - ) + [2016-11-30 15:05:15] Copying static.php to front-static.php + [2016-11-30 15:05:15] Command:git apply /var/www/html/magento2/vendor/magento/magento-cloud-configuration/patches/000-MAGETWO-57719-2.1.2.patch + [2016-11-30 15:05:15] Status:0 + [2016-11-30 15:05:15] Output:array ( + ) + [2016-11-30 15:05:15] Command:git apply /var/www/html/magento2/vendor/magento/magento-cloud-configuration/patches/MAGETWO-52660-scd-improvement.patch + [2016-11-30 15:05:15] Status:0 + [2016-11-30 15:05:15] Output:array ( + ) - ... more ... - ) + ... more ... + ) -2. Apply hotfixes and other patches provided to you: +2. Apply hotfixes and other patches provided to you: - git apply + git apply - For example, to apply hotfixes: + For example, to apply hotfixes: - git apply m2-hotfixes/ + git apply m2-hotfixes/ - If the `m2-hotfixes` directory is empty, skip this step. + If the `m2-hotfixes` directory is empty, skip this step. - If patches are present, output from this command is similar to the patches command. + If patches are present, output from this command is similar to the patches command. 1. Enable all missing modules. ```bash @@ -135,7 +135,7 @@ Before you continue, you must know the file system path to any patch we provided php bin/magento setup:di:compile ``` - This command can take several minutes to complete and produces messages similar to the following: + This command can take several minutes to complete and produces messages similar to the following: ```terminal Compilation was started. @@ -159,29 +159,29 @@ We strongly recommend you complete your testing in an Integration or Staging env We highly recommend having Magento already installed prior to deployment. During the [deployment phase]({{ page.baseurl }}/cloud/reference/discover-deploy.html#cloud-deploy-over-phases-hook), we perform the following tasks: -* Install the Magento application if needed -* If the Magento application is installed, upgrade components -* Clear the [cache](https://glossary.magento.com/cache) -* Set the Magento application for [`production`]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode) mode +* Install the Magento application if needed +* If the Magento application is installed, upgrade components +* Clear the [cache](https://glossary.magento.com/cache) +* Set the Magento application for [`production`]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode) mode #### To deploy your site: -1. If you have not already, log in as or switch to the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html). -2. Change to your project root directory. -3. Enter the following command: +1. If you have not already, log in as or switch to the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html). +2. Change to your project root directory. +3. Enter the following command: ```bash php bin/magento setup:upgrade ``` - We highly recommend having Magento already installed if you followed the [First time deployment]({{ page.baseurl }}/cloud/setup/first-time-deploy.html). If you have not installed the Magento application yet, use the [`magento setup:install`]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) command instead. Be advised, you may encounter issues with enabled modules on a fresh installation. -4. Clean the Magento cache: + We highly recommend having Magento already installed if you followed the [First time deployment]({{ page.baseurl }}/cloud/setup/first-time-deploy.html). If you have not installed the Magento application yet, use the [`magento setup:install`]({{ page.baseurl }}/install-gde/install/cli/install-cli.html) command instead. Be advised, you may encounter issues with enabled modules on a fresh installation. +4. Clean the Magento cache: ```bash php bin/magento cache:clean ``` -5. Set the Magento application for [production mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode): +5. Set the Magento application for [production mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#production-mode): ```bash php bin/magento deploy:mode:set production diff --git a/guides/v2.2/cloud/live/sens-data-initial.md b/guides/v2.2/cloud/live/sens-data-initial.md index 30ed461c57c..8ae99ddcbbe 100644 --- a/guides/v2.2/cloud/live/sens-data-initial.md +++ b/guides/v2.2/cloud/live/sens-data-initial.md @@ -10,16 +10,16 @@ Configuration management exports your configurations to a file for pushing acros This example shows how to use the [recommended procedure]({{ page.baseurl }}/cloud/live/sens-data-over.html#cloud-config-specific-recomm) for managing the configuration: -1. Enter your configurations in your Integration environment Admin panel. -2. Create `config.php` and transfer it to your local system. -3. Push `config.php` to the branch and Integration environment. -4. Verify your settings are not editable in the Admin panel. Any configurations exported to `config.php` make those fields in the Admin panel read-only and disabled for edits. -5. Update and modify configurations again in Integration, update the file, and check it into Git: +1. Enter your configurations in your Integration environment Admin panel. +2. Create `config.php` and transfer it to your local system. +3. Push `config.php` to the branch and Integration environment. +4. Verify your settings are not editable in the Admin panel. Any configurations exported to `config.php` make those fields in the Admin panel read-only and disabled for edits. +5. Update and modify configurations again in Integration, update the file, and check it into Git: - * Change configuration settings on the Integration environment. - * To add new configurations, run the command to create `config.php` again. New configurations are appended to the file. - * To remove or edit existing configurations, manually edit the file. - * Commit and push to Git. + * Change configuration settings on the Integration environment. + * To add new configurations, run the command to create `config.php` again. New configurations are appended to the file. + * To remove or edit existing configurations, manually edit the file. + * Commit and push to Git. ``` diff --git a/guides/v2.2/coding-standards/docblock-standard-javascript.md b/guides/v2.2/coding-standards/docblock-standard-javascript.md index a89b496d7e7..c76781db018 100644 --- a/guides/v2.2/coding-standards/docblock-standard-javascript.md +++ b/guides/v2.2/coding-standards/docblock-standard-javascript.md @@ -28,9 +28,9 @@ It is recommended to avoid sentence fragments in documentation blocks. Use sente JSDoc comments requirements: -* A JSDoc comment should begin with a slash (/) and two asterisks (*). -* Inline tags should be enclosed in braces: `{ @code this }`. -* `@desc` Block tags should always start on their own line. +* A JSDoc comment should begin with a slash (/) and two asterisks (*). +* Inline tags should be enclosed in braces: `{ @code this }`. +* `@desc` Block tags should always start on their own line. Example: @@ -334,427 +334,427 @@ namespace.readNumber = function(x) { ### JavaScript types {#frontend-dev-guide-javascript-js-coding-docblock-jstypes} - - - - - - - - - + + + + + + + + - - - - - - - - - + + + + + + + + - - - - - + + + + - - - - - + + + + - - - - - - - - - - + + + + + + + + + - - - - + + + - - - - - - - - - - - - + + + + + + + + + + + - - - - - + + + + - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - + + + + + + + + - - - - - + + + - - - - - + + + + - - - - - + + + + - - - - + + + - - - - + + + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
    Type exampleValue exampleDescription
    number
    1
+
    Type exampleValue exampleDescription
    number
    1
 1.0
 -5
 1e5
 Math.PI
    		 -
    Number
    new Number(true)
    		Number object
    string
    'Hello'
+
    		+
    Number
    new Number(true)
    		Number object
    string
    'Hello'
 "World"
 String(42)
    		String value
    String
    new String('Hello')
+
    		String value
    String
    new String('Hello')
 new String(42)
    		String object
    boolean
    true
+
    		String object
    boolean
    true
 false
 Boolean(0)
    		Boolean value
    Boolean
    new Boolean(true)
    		Boolean object
    RegExp
    new RegExp('hello')
+
    		Boolean value
    Boolean
    new Boolean(true)
    		Boolean object
    RegExp
    new RegExp('hello')
 /world/g
    		 -
    Date
    new Date
+
    		+
    Date
    new Date
 new Date()
    		 -
    null
    null
    		 -
    undefined
    undefined
    		 -
    void
    function f() {
-	return;
+
    		+
    null
    null
    		 +
    undefined
    undefined
    		 +
    void
    function f() {
+ return;
 }
    		No return value
    Array
    ['foo', 0.3, null]
+
    		No return value
    Array
    ['foo', 0.3, null]
 []
    		Untyped Array
    Array.<number>
    [11, 22, 33]
    		An array of numbers
    Array.>
    [['one', 'two', 'three'], ['foo', 'bar']]
    		Array of arrays of strings
    Object
    {}
+
    		Untyped Array
    Array.<number>
    [11, 22, 33]
    		An array of numbers
    Array.>
    [['one', 'two', 'three'], ['foo', 'bar']]
    		Array of arrays of strings
    Object
    {}
 {foo: 'abc', bar: 123, baz: null}
    		 -
    Object.<string>
    {'foo': 'bar'}
    		An object. In the object, the values are strings.
    Object.
    var obj = {};
+
    		+
    Object.<string>
    {'foo': 'bar'}
    		An object. In the object, the values are strings.
    Object.
    var obj = {};
 obj[1] = 'bar';
    		An object. In the object, the keys are numbers and the values are strings. + An object. In the object, the keys are numbers and the values are strings. Note that in JavaScript, the keys are always implicitly converted to strings, so obj['1'] == obj[1]. So the key will always be a string in for...in loops. But the compiler will verify the type if the key when indexing into the object.
    Function
    function(x, y) {
-	return x * y;
+
    Function
    function(x, y) {
+ return x * y;
 }
    		Function object
    function(number, number): number
    function(x, y) {
-	return x * y;
+
    		Function object
    function(number, number): number
    function(x, y) {
+ return x * y;
 }
    		function value
    SomeClass
    /** @constructor */
+
    		function value
    SomeClass
    /** @constructor */
 function SomeClass() {}
 
 new SomeClass();
    		 -
    SomeInterface
    /** @interface */
+
    		+
    SomeInterface
    /** @interface */
 function SomeInterface() {}
 
 SomeInterface.prototype.draw = function() {};
    		 -
    project.MyClass
    /** @constructor */
+
    		+
    project.MyClass
    /** @constructor */
 project.MyClass = function () {}
 
 new project.MyClass()
    		 -
    Element
    document.createElement('div')
    		Elements in the DOM.
    Node
    document.body.firstChild
    		Nodes in the DOM.
    HTMLInputElement
    htmlDocument.getElementsByTagName('input')[0]
    		A specific type of DOM element.
    +
    Element
    document.createElement('div')
    		Elements in the DOM.
    Node
    document.body.firstChild
    		Nodes in the DOM.
    HTMLInputElement
    htmlDocument.getElementsByTagName('input')[0]
    		A specific type of DOM element.
    #### JavaScript type language {#frontend-dev-guide-javascript-js-coding-docblock-typelang} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    - Operator name - - Syntax - - Description - - Deprecated syntaxes -
    - Type Name - - {boolean}, {Window}, {namespace.ui.Menu} - - Simply the name of a type. - -
    - Type Application - - {Array. <string>}
    - An array of strings.
    - {Object. }
    - An object. In the object, the keys are strings and the - values are numbers. -     		- Parametrizes a type, by applying a set of type arguments to - that type. The idea is analogous to generics in Java. - -
    - Type Union - - {(number|boolean)}
    - A number or a boolean. -     		- Indicates that a value might have type A OR type B. - - {(number,boolean)}, {number|boolean}, - {(number||boolean)} -
    - Record Type - - codemyNum: number, myObject}}
    - An anonymous type with the given type members. -     		- Indicates that the value has the specified members with the - specified types. In this case, myNum with a - type number and myObject with any - type. Note that the braces are part of the type syntax. For - example, to denote an Array of objects that - have a length property, you might write - Array.<{length}>. - -
    - Nullable type - - {?number}
    - A number or NULL. -     		- Indicates that a value is type A or null. By - default, all object types are nullable. NOTE: Function - types are not nullable. - - {number?} -
    - Non-nullable type - - {!Object}
    - An Object, but never the null value. -     		- Indicates that a value is type A and not null. By default, - all value types (boolean, number, string, and undefined) - are not nullable. - - {Object!} -
    - Function Type - - {function(string, boolean)}
    - A function that takes two arguments (a string and a - boolean), and has an unknown return value. -     		- Specifies a function. - -
    - Function Return Type - - {function(): number}
    - A function that takes no arguments and returns a number. -     		- Specifies a function return type. - -
    - Function this Type - - {function(this:namespace.ui.Menu, - string)}
    - A function that takes one argument (a string), and executes - in the context of a namespace.ui.Menu. -     		- Specifies the context type of a function type. - -
    - Function new Type - - {function(new:namespace.ui.Menu, - string)}
    - A constructor that takes one argument (a string), and - creates a new instance of namespace.ui.Menu when called - with the 'new' keyword. -     		- Specifies the constructed type of a constructor. - -
    - Variable arguments - - {function(string, ...[number]): number}
    - A function that takes one argument (a string), and then a - variable number of arguments that must be numbers. -     		- Specifies variable arguments to a function. - -
    - Variable arguments (in @param/ annotations) - - @param {...number} var_args
    - A variable number of arguments to an annotated function. -     		- Specifies that the annotated function accepts a variable - number of arguments. - -
    - Function optional arguments - - {function(?string=, number=)}
    - A function that takes one optional, nullable string and one - optional number as arguments. The = syntax is only for - function type declarations. -     		- Specifies optional arguments to a function. - -
    - Function optional arguments (in @param - annotations) - - @param {number=} opt_argument
    - An optional parameter of type number. -     		- Specifies that the annotated function accepts an optional - argument. - -
    - The ALL type - - {*} - - Indicates that the variable can take on any type. - -
    - The UNKNOWN type - - {?} - - Indicates that the variable can take on any type, and the - compiler should not type-check any uses of it. - -
    + Operator name + + Syntax + + Description + + Deprecated syntaxes +
    + Type Name + + {boolean}, {Window}, {namespace.ui.Menu} + + Simply the name of a type. + +
    + Type Application + + {Array. <string>}
    + An array of strings.
    + {Object. }
    + An object. In the object, the keys are strings and the + values are numbers. +     		+ Parametrizes a type, by applying a set of type arguments to + that type. The idea is analogous to generics in Java. + +
    + Type Union + + {(number|boolean)}
    + A number or a boolean. +     		+ Indicates that a value might have type A OR type B. + + {(number,boolean)}, {number|boolean}, + {(number||boolean)} +
    + Record Type + + codemyNum: number, myObject}}
    + An anonymous type with the given type members. +     		+ Indicates that the value has the specified members with the + specified types. In this case, myNum with a + type number and myObject with any + type. Note that the braces are part of the type syntax. For + example, to denote an Array of objects that + have a length property, you might write + Array.<{length}>. + +
    + Nullable type + + {?number}
    + A number or NULL. +     		+ Indicates that a value is type A or null. By + default, all object types are nullable. NOTE: Function + types are not nullable. + + {number?} +
    + Non-nullable type + + {!Object}
    + An Object, but never the null value. +     		+ Indicates that a value is type A and not null. By default, + all value types (boolean, number, string, and undefined) + are not nullable. + + {Object!} +
    + Function Type + + {function(string, boolean)}
    + A function that takes two arguments (a string and a + boolean), and has an unknown return value. +     		+ Specifies a function. + +
    + Function Return Type + + {function(): number}
    + A function that takes no arguments and returns a number. +     		+ Specifies a function return type. + +
    + Function this Type + + {function(this:namespace.ui.Menu, + string)}
    + A function that takes one argument (a string), and executes + in the context of a namespace.ui.Menu. +     		+ Specifies the context type of a function type. + +
    + Function new Type + + {function(new:namespace.ui.Menu, + string)}
    + A constructor that takes one argument (a string), and + creates a new instance of namespace.ui.Menu when called + with the 'new' keyword. +     		+ Specifies the constructed type of a constructor. + +
    + Variable arguments + + {function(string, ...[number]): number}
    + A function that takes one argument (a string), and then a + variable number of arguments that must be numbers. +     		+ Specifies variable arguments to a function. + +
    + Variable arguments (in @param/ annotations) + + @param {...number} var_args
    + A variable number of arguments to an annotated function. +     		+ Specifies that the annotated function accepts a variable + number of arguments. + +
    + Function optional arguments + + {function(?string=, number=)}
    + A function that takes one optional, nullable string and one + optional number as arguments. The = syntax is only for + function type declarations. +     		+ Specifies optional arguments to a function. + +
    + Function optional arguments (in @param + annotations) + + @param {number=} opt_argument
    + An optional parameter of type number. +     		+ Specifies that the annotated function accepts an optional + argument. + +
    + The ALL type + + {*} + + Indicates that the variable can take on any type. + +
    + The UNKNOWN type + + {?} + + Indicates that the variable can take on any type, and the + compiler should not type-check any uses of it. + +
    \ No newline at end of file diff --git a/guides/v2.2/comp-mgr/bk-compman-upgrade-guide.md b/guides/v2.2/comp-mgr/bk-compman-upgrade-guide.md index 82897b72db6..685d4b89ad2 100644 --- a/guides/v2.2/comp-mgr/bk-compman-upgrade-guide.md +++ b/guides/v2.2/comp-mgr/bk-compman-upgrade-guide.md @@ -14,13 +14,13 @@ functional_areas: This topic discusses the ways you can: -* Upgrade (that is, *patch*) the Magento software from version {{ page.guide_version }}.0 to {{ page.guide_version }}.1, for example -* Update any of the following: +* Upgrade (that is, *patch*) the Magento software from version {{ page.guide_version }}.0 to {{ page.guide_version }}.1, for example +* Update any of the following: - * Modules (also referred to as *extensions*; extend Magento capabilities) - * Themes (change the look and feel of your storefront and Admin) - * Language packages (localize the storefront and Admin) -* Uninstall extensions + * Modules (also referred to as *extensions*; extend Magento capabilities) + * Themes (change the look and feel of your storefront and Admin) + * Language packages (localize the storefront and Admin) +* Uninstall extensions ## Upgrade the Magento application @@ -29,10 +29,10 @@ The way you upgrade (that is, patch) the Magento application depends on how you * {{ce}} and {{ee}}: If you used [Composer] to install the Magento application or if you downloaded an [archive], use the [System Upgrade utility] or the [command line]. * {{ce}} only: If you cloned the Magento 2 GitHub repository because you are contributing code to the {{ce}} codebase, [upgrade the software manually]. * If your Magento root directory is ``, you can upgrade in any of the following ways: - * For the upgrade, create another subdomain or docroot that uses the Magento installation directory as its root. + * For the upgrade, create another subdomain or docroot that uses the Magento installation directory as its root. - Run the System Upgrade utility as discussed in this topic using that subdomain or docroot. - * Upgrade the Magento software using the [command line]. + Run the System Upgrade utility as discussed in this topic using that subdomain or docroot. + * Upgrade the Magento software using the [command line]. * To upgrade from {{ce}} to {{ee}}, see [Upgrade from Open Source to Commerce]. {:.bs-callout .bs-callout-info} diff --git a/guides/v2.2/comp-mgr/cli/cli-upgrade.md b/guides/v2.2/comp-mgr/cli/cli-upgrade.md index 208254a7cc2..4023870b14c 100644 --- a/guides/v2.2/comp-mgr/cli/cli-upgrade.md +++ b/guides/v2.2/comp-mgr/cli/cli-upgrade.md @@ -126,5 +126,5 @@ To enable maintenance mode: 1. Reset [file system ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html) as a user with `root` privileges. 2. Clear the following directories and try again: * `/var/cache` - * `/var/page_cache` - * `/generated/code` + * `/var/page_cache` + * `/generated/code` diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-backup.md b/guides/v2.2/comp-mgr/extens-man/extensman-backup.md index 7dfa1409109..55e202de397 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-backup.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-backup.md @@ -17,7 +17,7 @@ functional_areas: After your backup is complete, continue with any of the following: -* Installing extensions: [Step 3. Install]({{ page.baseurl }}/comp-mgr/extens-man/extensman-new-purchase.html) -* Updating extensions: [Step 3. Extension Update]({{ page.baseurl }}/comp-mgr/extens-man/extensman-update.html) -* Uninstalling extensions: [Step 3. Data Option]({{ page.baseurl }}/comp-mgr/extens-man/extensman-uninst-data.html) +* Installing extensions: [Step 3. Install]({{ page.baseurl }}/comp-mgr/extens-man/extensman-new-purchase.html) +* Updating extensions: [Step 3. Extension Update]({{ page.baseurl }}/comp-mgr/extens-man/extensman-update.html) +* Uninstalling extensions: [Step 3. Data Option]({{ page.baseurl }}/comp-mgr/extens-man/extensman-uninst-data.html) diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-checklist.md b/guides/v2.2/comp-mgr/extens-man/extensman-checklist.md index 69b40a40dca..56c13926b9a 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-checklist.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-checklist.md @@ -13,9 +13,9 @@ functional_areas: The [Extension](https://glossary.magento.com/extension) Manager enables you to install, uninstall, and update extensions, including those you purchase from Magento Marketplace. The term *extension* means: -* Modules (extend Magento capabilities) -* Themes (change the look and feel of your [storefront](https://glossary.magento.com/storefront) and Admin) -* Language packages (localize the storefront and Admin) +* Modules (extend Magento capabilities) +* Themes (change the look and feel of your [storefront](https://glossary.magento.com/storefront) and Admin) +* Language packages (localize the storefront and Admin) {: .bs-callout .bs-callout-warning } If you installed the Magento application by [cloning the GitHub repository]({{ page.baseurl }}/install-gde/prereq/dev_install.html), you *cannot* use the Extension Manager to update components. Instead, you must [update them manually]({{ page.baseurl }}/install-gde/install/cli/dev_options.html). diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-main-pg.md b/guides/v2.2/comp-mgr/extens-man/extensman-main-pg.md index 99db4838f53..a9d0ab0dd42 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-main-pg.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-main-pg.md @@ -13,31 +13,31 @@ functional_areas: To start the [Extension](https://glossary.magento.com/extension) Manager: -1. If you haven't done so already, create or get your [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html). -2. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. -3. Click **System** > **Web Setup Wizard**. -4. Click **Extension Manager** as the following figure shows. +1. If you haven't done so already, create or get your [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html). +2. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. +3. Click **System** > **Web Setup Wizard**. +4. Click **Extension Manager** as the following figure shows. - ![Click the Extension Manager]({{ site.baseurl }}/common/images/extens_mgr_select.png){:width="550px"} + ![Click the Extension Manager]({{ site.baseurl }}/common/images/extens_mgr_select.png){:width="550px"} -5. If prompted, log in to the Extension Manager. +5. If prompted, log in to the Extension Manager. - The following page displays if a login is required. + The following page displays if a login is required. - ![Install or upgrade extensions]({{ site.baseurl }}/common/images/extens_mgr_login.png){:width="400px"} + ![Install or upgrade extensions]({{ site.baseurl }}/common/images/extens_mgr_login.png){:width="400px"} -6. Enter your authentication keys in the provided fields. -2. Click **Submit**. +6. Enter your authentication keys in the provided fields. +2. Click **Submit**. {:.bs-callout .bs-callout-warning} You must use the same authentication keys you used to install the Magento software. For example, you *cannot* use {{site.data.var.ce}} authentication keys to update or upgrade {{site.data.var.ee}} or vice versa. You also *cannot* use another user's authentication keys or [Shared account](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html) authentication keys See one of the following sections: -* [Choose what to install, uninstall, or update](#extens-choose) -* [Install extensions](#extensman-install) -* [Uninstall extensions](#extensman-uninstall) -* [Update extensions](#extensman-update) +* [Choose what to install, uninstall, or update](#extens-choose) +* [Install extensions](#extensman-install) +* [Uninstall extensions](#extensman-uninstall) +* [Update extensions](#extensman-update) ## Choose what to install, uninstall, or update {#extens-choose} @@ -45,11 +45,11 @@ After you log in to the Extension Manager, a list displays as follows: ![Choose what to install, update, or uninstall]({{ site.baseurl }}/common/images/extens_mgr_updates.png){:width="500px"} -* **Updates Available** displays the number of extensions you can update. -* **Extensions Ready to Install** displays the number of extensions you can install. -* **Last Refresh** displays the last time you refreshed the list of extensions on Magento Marketplace. +* **Updates Available** displays the number of extensions you can update. +* **Extensions Ready to Install** displays the number of extensions you can install. +* **Last Refresh** displays the last time you refreshed the list of extensions on Magento Marketplace. - Click **Refresh** to update the information, such as after you purchase new extensions. + Click **Refresh** to update the information, such as after you purchase new extensions. ### Supported actions for each type {#extens-choose-pertype} @@ -63,18 +63,18 @@ The following figure shows how types display in the Extension Manager. Following is a definition of types: -* `module` for a module (that is, PHP code that modifies Magento behavior) -* `language` for a language package used to translate the Magento storefront and Admin -* `theme` for a collection of styles that affect the look of the storefront or Admin -* `library` for a library—such as a shared third-party library -* `component` for any type of component that must be installed in the Magento root directory (this is a relatively uncommon type) +* `module` for a module (that is, PHP code that modifies Magento behavior) +* `language` for a language package used to translate the Magento storefront and Admin +* `theme` for a collection of styles that affect the look of the storefront or Admin +* `library` for a library—such as a shared third-party library +* `component` for any type of component that must be installed in the Magento root directory (this is a relatively uncommon type) Actions are further divided between those available for *metapackages* (that is, an installable package that contains a group of different types) or *non-metapackages* (that is, a single type). The following sections provide details: -* [Actions available for non-metapackages](#extensman-access-types-non-meta) -* [Actions available for metapackages](#extensman-access-types-meta) +* [Actions available for non-metapackages](#extensman-access-types-non-meta) +* [Actions available for metapackages](#extensman-access-types-meta) #### Actions available for non-metapackages {#extensman-access-types-non-meta} @@ -83,39 +83,39 @@ Most extensions you get from Magento Marketplace or another source have only one The following table shows which actions are supported for each non-metapackage. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    TypeUpdateUninstall
    moduleYesYes
    language package and themeYesYes
    libraryYesYes
    componentYesYes
    + + + + Type + Update + Uninstall + + + module + Yes + Yes + + + language package and theme + Yes + Yes + + + library + Yes + Yes + + + component + Yes + Yes + + + #### Actions available for metapackages {#extensman-access-types-meta} @@ -124,38 +124,38 @@ A metapackage is an installable package that includes more than one type. For ex The following table shows which actions are available for a metapackage. - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeUpdateUninstall
    moduleNoNo
    language package and themeYesYes
    libraryYesYes
    componentYesYes
    TypeUpdateUninstall
    moduleNoNo
    language package and themeYesYes
    libraryYesYes
    componentYesYes
    {% endcollapsible %} @@ -186,13 +186,13 @@ To install one extension, click the **Install** link at the end of its row and c To install more than one extension: -1. Select the checkbox next to each extension, or click **Select All** from the list as the following figure shows. +1. Select the checkbox next to each extension, or click **Select All** from the list as the following figure shows. - ![Choose extensions to install]({{ site.baseurl }}/common/images/extensman_choose-to-install.png){:width="550px"} -2. After you select what to install, click **Install** at the top of the page as the following figure shows. + ![Choose extensions to install]({{ site.baseurl }}/common/images/extensman_choose-to-install.png){:width="550px"} +2. After you select what to install, click **Install** at the top of the page as the following figure shows. - ![Install your purchases]({{ site.baseurl }}/common/images/extensman_ready-to-install.png){:width="550px"} -3. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness.html). + ![Install your purchases]({{ site.baseurl }}/common/images/extensman_ready-to-install.png){:width="550px"} +3. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness.html). {% endcollapsible %} @@ -200,12 +200,12 @@ To install more than one extension: {% collapsible To uninstall extensions: %} -1. In the Installed Extensions section, click **Uninstall** from the **Actions** list as the following figure shows. +1. In the Installed Extensions section, click **Uninstall** from the **Actions** list as the following figure shows. - ![Uninstall extensions]({{ site.baseurl }}/common/images/extensman_uninstall.png){:width="600px"} + ![Uninstall extensions]({{ site.baseurl }}/common/images/extensman_uninstall.png){:width="600px"} - If no **Uninstall** option is available, the vendor did not provide an uninstallation script. Contact the vendor for uninstallation instructions. -3. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness.html). + If no **Uninstall** option is available, the vendor did not provide an uninstallation script. Contact the vendor for uninstallation instructions. +3. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness.html). {% endcollapsible %} @@ -219,13 +219,13 @@ The New Updates page displays all extensions that can be updated. You have the following options: -* To update one extension, click **Update** at the end of its row. -* To update more than one extension, select its checkbox and click **Update**, as the following figure shows. +* To update one extension, click **Update** at the end of its row. +* To update more than one extension, select its checkbox and click **Update**, as the following figure shows. - ![Update selected extensions]({{ site.baseurl }}/common/images/extensman_update-selected.png){:width="500px"} -* To update all extensions, click **Select All** from the list and click **Update**, as the following figure shows. + ![Update selected extensions]({{ site.baseurl }}/common/images/extensman_update-selected.png){:width="500px"} +* To update all extensions, click **Select All** from the list and click **Update**, as the following figure shows. - ![Update all extensions]({{ site.baseurl }}/common/images/extensman_update-all.png) + ![Update all extensions]({{ site.baseurl }}/common/images/extensman_update-all.png) Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness.html). diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-readiness-fail.md b/guides/v2.2/comp-mgr/extens-man/extensman-readiness-fail.md index 8c219f7efe8..4cdc79b6dfd 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-readiness-fail.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-readiness-fail.md @@ -22,9 +22,9 @@ If you're updating multiple extensions, see [Readiness check with multiple exten In the [event](https://glossary.magento.com/event) of failure, see one of the following sections: -* Updater check failure -* Cron script check failure -* Component dependency check failure -* PHP version readiness check issues -* PHP settings errors -* PHP extensions check failure +* Updater check failure +* Cron script check failure +* Component dependency check failure +* PHP version readiness check issues +* PHP settings errors +* PHP extensions check failure diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-readiness-multi.md b/guides/v2.2/comp-mgr/extens-man/extensman-readiness-multi.md index d2d4c1ea4cb..c8b89b741e9 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-readiness-multi.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-readiness-multi.md @@ -23,9 +23,9 @@ If you're updating multiple extensions, the readiness check displays success and You have the following options: -* Click **Update** or **Next** to continue to [Step 2. Backup]({{ page.baseurl }}/comp-mgr/extens-man/extensman-backup.html) with no changes -* To update the extension to a different version, select the desired version from the list -* To remove the extension from the list and *not* update it, click ![Remove extension from the list]({{ site.baseurl }}/common/images/extensman_delete.png) (delete) +* Click **Update** or **Next** to continue to [Step 2. Backup]({{ page.baseurl }}/comp-mgr/extens-man/extensman-backup.html) with no changes +* To update the extension to a different version, select the desired version from the list +* To remove the extension from the list and *not* update it, click ![Remove extension from the list]({{ site.baseurl }}/common/images/extensman_delete.png) (delete) If you make changes, click **Try Again**. @@ -41,9 +41,9 @@ If the readiness check fails because of version conflicts, you must resolve the You have the following options: -* Click **Back** and select different extensions to update -* From the list, click different versions of the selected extensions -* To remove the extension from the list and *not* update it, click ![Remove extension from the list]({{ site.baseurl }}/common/images/extensman_delete.png) (delete) +* Click **Back** and select different extensions to update +* From the list, click different versions of the selected extensions +* To remove the extension from the list and *not* update it, click ![Remove extension from the list]({{ site.baseurl }}/common/images/extensman_delete.png) (delete) After you make your changes, click **Try Again**. Repeat the process as necessary to resolve the conflicts. @@ -59,12 +59,12 @@ Messages similar to the following display if a readiness check fails. In the event of failure, see one of the following sections: -* [Updater check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) -* [Cron script check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) -* [Component dependency check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) -* [PHP version readiness check issues]({{ page.baseurl }}/comp-mgr/trouble/cman/php-version.html) -* [PHP settings errors]({{ page.baseurl }}/install-gde/trouble/php/tshoot_php-set.html) -* [PHP extensions check failure]({{ page.baseurl }}/install-gde/system-requirements.html) +* [Updater check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) +* [Cron script check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) +* [Component dependency check failure]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) +* [PHP version readiness check issues]({{ page.baseurl }}/comp-mgr/trouble/cman/php-version.html) +* [PHP settings errors]({{ page.baseurl }}/install-gde/trouble/php/tshoot_php-set.html) +* [PHP extensions check failure]({{ page.baseurl }}/install-gde/system-requirements.html) {% endcollapsible %} diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-readiness.md b/guides/v2.2/comp-mgr/extens-man/extensman-readiness.md index 0baea2c452e..8b525da214f 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-readiness.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-readiness.md @@ -21,7 +21,7 @@ To start, click either **Start Readiness Check** or **Next**. A sample follows. After the readiness check completes, see one of the following: -* [Readiness check success]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-success.html) -* [Readiness check failure]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-fail.html) -* [Readiness check with multiple extension updates]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-multi.html) +* [Readiness check success]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-success.html) +* [Readiness check failure]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-fail.html) +* [Readiness check with multiple extension updates]({{ page.baseurl }}/comp-mgr/extens-man/extensman-readiness-multi.html) diff --git a/guides/v2.2/comp-mgr/extens-man/extensman-uninst-data.md b/guides/v2.2/comp-mgr/extens-man/extensman-uninst-data.md index 7b99ec0708a..b23d678b749 100644 --- a/guides/v2.2/comp-mgr/extens-man/extensman-uninst-data.md +++ b/guides/v2.2/comp-mgr/extens-man/extensman-uninst-data.md @@ -19,7 +19,7 @@ After backing up, you have the choice of removing data from the Magento 2 databa If the [extension](https://glossary.magento.com/extension) has no data to remove, the following message displays. (If a extension has data but no uninstall script, the same prompt displays. In that case, contact the vendor or remove database data manually.) - The selected extension has no data to remove. + The selected extension has no data to remove. If the extension has data to remove, a page similar to the following displays. @@ -27,10 +27,10 @@ If the extension has data to remove, a page similar to the following displays. Click one of the following: -* **Keep data**: Click to keep the data in the database. -* **Remove data**: Click to remove data from the database. +* **Keep data**: Click to keep the data in the database. +* **Remove data**: Click to remove data from the database. - You can click **Back** to back up the database first if you did not do so already. + You can click **Back** to back up the database first if you did not do so already. Continue with [Step 4. Uninstall]({{ page.baseurl }}/comp-mgr/extens-man/extensman-uninst-final.html) diff --git a/guides/v2.2/comp-mgr/marketplace/marketplace.md b/guides/v2.2/comp-mgr/marketplace/marketplace.md index 7d7def99bb0..717c18ed631 100644 --- a/guides/v2.2/comp-mgr/marketplace/marketplace.md +++ b/guides/v2.2/comp-mgr/marketplace/marketplace.md @@ -17,12 +17,12 @@ To get started, log in to [Magento Marketplace](https://marketplace.magento.com) If you don't have an account yet: -1. Click **Sign In** and the top right of the page as the following figure shows: +1. Click **Sign In** and the top right of the page as the following figure shows: - ![Sign in to Marketplace]({{ site.baseurl }}/common/images/marketplace_sign-in.png){:width="600px"} -2. In the right pane, click **Create an account**. + ![Sign in to Marketplace]({{ site.baseurl }}/common/images/marketplace_sign-in.png){:width="600px"} +2. In the right pane, click **Create an account**. - ![Create a Marketplace account]({{ site.baseurl }}/common/images/marketplace_create-acct.png){:width="300px"} + ![Create a Marketplace account]({{ site.baseurl }}/common/images/marketplace_create-acct.png){:width="300px"} ### Find an extension or theme diff --git a/guides/v2.2/comp-mgr/module-man/compman-start.md b/guides/v2.2/comp-mgr/module-man/compman-start.md index 2d420fe1299..4a77cf08aab 100644 --- a/guides/v2.2/comp-mgr/module-man/compman-start.md +++ b/guides/v2.2/comp-mgr/module-man/compman-start.md @@ -13,18 +13,18 @@ functional_areas: To run the [Module](https://glossary.magento.com/module) Manager: -1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. -2. Click **System** > **Web Setup Wizard**. -3. Click **Module Manager**. +1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. +2. Click **System** > **Web Setup Wizard**. +3. Click **Module Manager**. - ![]({{ site.baseurl }}/common/images/modman_select.png){:width="550px"} + ![]({{ site.baseurl }}/common/images/modman_select.png){:width="550px"} To upgrade Magento system software instead, see [Run System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). See one of the following sections: -* [About the Module Manager](#modman-about) -* [Enable or disable a module](#modman-about-endis) +* [About the Module Manager](#modman-about) +* [Enable or disable a module](#modman-about-endis) ## About the Module Manager {#modman-about} @@ -61,7 +61,7 @@ This example shows how to disable a currently enabled module. You can use the sa To disable a module: -1. Click **Disable** from the **Action** column, as the following figure shows. +1. Click **Disable** from the **Action** column, as the following figure shows. - ![Disable a module]({{ site.baseurl }}/common/images/modman_disable.png) -2. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/module-man/compman-readiness.html). + ![Disable a module]({{ site.baseurl }}/common/images/modman_disable.png) +2. Continue with [Step 1. Readiness check]({{ page.baseurl }}/comp-mgr/module-man/compman-readiness.html). diff --git a/guides/v2.2/comp-mgr/prereq/prereq_compman-checklist.md b/guides/v2.2/comp-mgr/prereq/prereq_compman-checklist.md index 3c24be3f048..4505ddc071f 100644 --- a/guides/v2.2/comp-mgr/prereq/prereq_compman-checklist.md +++ b/guides/v2.2/comp-mgr/prereq/prereq_compman-checklist.md @@ -7,10 +7,10 @@ functional_areas: Before you continue, to avoid errors during your installation or update, make sure you verify *all* of the following: -* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group -* Your [cron jobs](#magento-cron) are set up and running -* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size) -* [File system permissions](#perms) are set properly +* You set up a [Magento file system owner](#magento-owner-group) and shared that owner's group with the web server user group +* Your [cron jobs](#magento-cron) are set up and running +* [Set a value for DATA_CONVERTER_BATCH_SIZE](#batch-size) +* [File system permissions](#perms) are set properly {: .bs-callout .bs-callout-warning } Do not continue without performing these checks. Failure to do so could result in errors. diff --git a/guides/v2.2/comp-mgr/prereq/prereq_compman.md b/guides/v2.2/comp-mgr/prereq/prereq_compman.md index d9b6bb0d7d2..8e76d63151f 100644 --- a/guides/v2.2/comp-mgr/prereq/prereq_compman.md +++ b/guides/v2.2/comp-mgr/prereq/prereq_compman.md @@ -13,12 +13,12 @@ functional_areas: Before running the [Module](https://glossary.magento.com/module) Manager, [Extension](https://glossary.magento.com/extension) Manager, or System Upgrade, complete the following tasks: -* [Set up cron]({{ page.baseurl }}/comp-mgr/prereq/prereq_cron.html) -* [Set `ulimit` for the web server user]({{ page.baseurl }}/comp-mgr/prereq/prereq_compman-ulimit.html) -* [Checklist]({{ page.baseurl }}/comp-mgr/prereq/prereq_compman-checklist.html) +* [Set up cron]({{ page.baseurl }}/comp-mgr/prereq/prereq_cron.html) +* [Set `ulimit` for the web server user]({{ page.baseurl }}/comp-mgr/prereq/prereq_compman-ulimit.html) +* [Checklist]({{ page.baseurl }}/comp-mgr/prereq/prereq_compman-checklist.html) After you've completed all prerequisites, continue with: -* [Module Manager]({{ page.baseurl }}/comp-mgr/module-man/compman-start.html) -* [Extension Manager]({{ page.baseurl }}/comp-mgr/extens-man/extensman-main-pg.html) -* [System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) +* [Module Manager]({{ page.baseurl }}/comp-mgr/module-man/compman-start.html) +* [Extension Manager]({{ page.baseurl }}/comp-mgr/extens-man/extensman-main-pg.html) +* [System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html) diff --git a/guides/v2.2/comp-mgr/trouble/cman/ce-ee-upgrade.md b/guides/v2.2/comp-mgr/trouble/cman/ce-ee-upgrade.md index a25ad0531ae..6c1659fe58f 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/ce-ee-upgrade.md +++ b/guides/v2.2/comp-mgr/trouble/cman/ce-ee-upgrade.md @@ -14,22 +14,22 @@ functional_areas: Your upgrade from **{{site.data.var.ce}}** to **{{site.data.var.ee}}** might fail with the following error: ```terminal - [2016-01-19 23:33:24 UTC] An error occurred while executing job - "setup:upgrade {"command":"setup:upgrade"}": Could not complete - setup:upgrade {"command":"setup:upgrade"} successfully: Source - class "\Cybersource" for "CybersourceLogger" generation does not exist. + [2016-01-19 23:33:24 UTC] An error occurred while executing job + "setup:upgrade {"command":"setup:upgrade"}": Could not complete + setup:upgrade {"command":"setup:upgrade"} successfully: Source + class "\Cybersource" for "CybersourceLogger" generation does not exist. ``` If this error displays, resolve it as follows: -1. Log in to your Magento server as the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). -2. Enter the following commands in the order shown: +1. Log in to your Magento server as the [Magento file system owner](https://glossary.magento.com/magento-file-system-owner). +2. Enter the following commands in the order shown: ```bash php /bin/magento setup:upgrade ``` -3. After the command completes, verify your upgrade was successful: +3. After the command completes, verify your upgrade was successful: ```bash bin/magento --version diff --git a/guides/v2.2/comp-mgr/trouble/cman/cron.md b/guides/v2.2/comp-mgr/trouble/cman/cron.md index 7bed528b5fe..7e09c4886a3 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/cron.md +++ b/guides/v2.2/comp-mgr/trouble/cman/cron.md @@ -11,22 +11,22 @@ functional_areas: Following are symptoms of cron issues: -* Your update or upgrade never runs; it stays in a `pending` state -* An error message about the [PHP](https://glossary.magento.com/php) setting `$HTTP_RAW_POST_DATA` displays even though it's set properly -* The cron readiness check fails +* Your update or upgrade never runs; it stays in a `pending` state +* An error message about the [PHP](https://glossary.magento.com/php) setting `$HTTP_RAW_POST_DATA` displays even though it's set properly +* The cron readiness check fails - Possible errors include non-writable paths and cron not set up. An example follows: + Possible errors include non-writable paths and cron not set up. An example follows: - -* The PHP readiness check doesn't display the PHP version as the following figure shows. + +* The PHP readiness check doesn't display the PHP version as the following figure shows. - -* The following error displays in the Magento Admin: + +* The following error displays in the Magento Admin: - ![cron isn't running]({{ site.baseurl }}/common/images/compman-cron-not-running.png) + ![cron isn't running]({{ site.baseurl }}/common/images/compman-cron-not-running.png) - To see the error, you might need to click **System Messages** at the top of the window as follows: + To see the error, you might need to click **System Messages** at the top of the window as follows: - ![System Messages]({{ site.baseurl }}/common/images/compman_sys-messages.png) + ![System Messages]({{ site.baseurl }}/common/images/compman_sys-messages.png) {% include install/trouble/rc_cron.md %} diff --git a/guides/v2.2/comp-mgr/trouble/cman/doc.md b/guides/v2.2/comp-mgr/trouble/cman/doc.md index d0aad7ac0e9..d83aff3321e 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/doc.md +++ b/guides/v2.2/comp-mgr/trouble/cman/doc.md @@ -11,20 +11,20 @@ functional_areas: When installing new purchases, you might see an error like the following during readiness check: - Command "update" failed: Loading composer repositories with package information - Updating dependencies (including require-dev) - Your requirements could not be resolved to an installable set of packages. + Command "update" failed: Loading composer repositories with package information + Updating dependencies (including require-dev) + Your requirements could not be resolved to an installable set of packages. - Problem 1 - - Installation request for magento/theme-doc-blank 100.0.2 -> satisfiable by magento/theme-doc-blank[100.0.2]. - - magento/theme-doc-blank 100.0.2 requires magento/framework 0.1.0 -> no matching package found. + Problem 1 + - Installation request for magento/theme-doc-blank 100.0.2 -> satisfiable by magento/theme-doc-blank[100.0.2]. + - magento/theme-doc-blank 100.0.2 requires magento/framework 0.1.0 -> no matching package found. - Potential causes: - - A typo in the package name - - The package is not available in a stable-enough version according to your minimum-stability setting - see for more details. + Potential causes: + - A typo in the package name + - The package is not available in a stable-enough version according to your minimum-stability setting + see for more details. - Read for further common problems. + Read for further common problems. ### Workaround @@ -32,7 +32,7 @@ This issue is caused by two `doc`-related components we published by mistake. Th The workaround is to go back to the Component Manager and deselect the following components: -* magento/theme-doc-blank -* magento/module-doc +* magento/theme-doc-blank +* magento/module-doc Your new purchase installation should proceed without issue. diff --git a/guides/v2.2/comp-mgr/trouble/cman/gitignore.md b/guides/v2.2/comp-mgr/trouble/cman/gitignore.md index c19ea71da30..6bfa24c9efa 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/gitignore.md +++ b/guides/v2.2/comp-mgr/trouble/cman/gitignore.md @@ -21,11 +21,11 @@ The following figure shows an example of this issue when using the Setup Wizard. To solve this issue: -1. Log in to your Magento server as the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). -2. Change to your Magento installation directory. -3. Run the following commands in the order shown: +1. Log in to your Magento server as the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). +2. Change to your Magento installation directory. +3. Run the following commands in the order shown: - composer update magento/magento-composer-installer - composer update + composer update magento/magento-composer-installer + composer update -4. Try your upgrade again. +4. Try your upgrade again. diff --git a/guides/v2.2/comp-mgr/trouble/cman/maint-mode.md b/guides/v2.2/comp-mgr/trouble/cman/maint-mode.md index 52e90c8cd9e..497caca810a 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/maint-mode.md +++ b/guides/v2.2/comp-mgr/trouble/cman/maint-mode.md @@ -18,16 +18,16 @@ You must perform the tasks in this section as a user with `root` privileges. See one of the following sections for more information: -* [Create the custom maintenance page](#compman-trouble-maint-create) -* [Custom maintenance page for Apache](#compman-trouble-maint-apache) -* [Custom maintenance page for nginx](#compman-trouble-maint-nginx) +* [Create the custom maintenance page](#compman-trouble-maint-create) +* [Custom maintenance page for Apache](#compman-trouble-maint-apache) +* [Custom maintenance page for nginx](#compman-trouble-maint-nginx) ## Create the custom maintenance page {#compman-trouble-maint-create} To create a maintenance page and redirect to it, first create a maintenance page named: -* Apache: `/maintenance.html` -* nginx: `/maintenance.html` +* Apache: `/maintenance.html` +* nginx: `/maintenance.html` Add to it the following contents: @@ -61,40 +61,40 @@ This section discusses how to create a custom maintenance page and how to redire The example in this section shows how to modify the following files, which is one way to set up your maintenance page: -* Apache 2.4: `/etc/apache2/sites-available/000-default.conf` -* Apache 2.2: `/etc/apache2/sites-available/default` (Ubuntu), `/etc/httpd/conf/httpd.conf` (CentOS) +* Apache 2.4: `/etc/apache2/sites-available/000-default.conf` +* Apache 2.2: `/etc/apache2/sites-available/default` (Ubuntu), `/etc/httpd/conf/httpd.conf` (CentOS) To redirect traffic to a custom maintenance page: -2. Update your Apache configuration to do the following: +2. Update your Apache configuration to do the following: - * Redirect all traffic to the maintenance page - * Whitelist certain IPs so an administrator can run the System Upgrade utility to upgrade the Magento software. + * Redirect all traffic to the maintenance page + * Whitelist certain IPs so an administrator can run the System Upgrade utility to upgrade the Magento software. - The following example whitelists 192.0.2.110. + The following example whitelists 192.0.2.110. - Add the following at the end of your Apache configuration file: + Add the following at the end of your Apache configuration file: - RewriteEngine On - RewriteCond %{REMOTE_ADDR} !^192\.0\.2\.110 - RewriteCond %{DOCUMENT_ROOT}/maintenance.html -f - RewriteCond %{DOCUMENT_ROOT}/maintenance.enable -f - RewriteCond %{SCRIPT_FILENAME} !maintenance.html - RewriteRule ^.*$ /maintenance.html [R=503,L] - ErrorDocument 503 /maintenance.html - Header Set Cache-Control "max-age=0, no-store" + RewriteEngine On + RewriteCond %{REMOTE_ADDR} !^192\.0\.2\.110 + RewriteCond %{DOCUMENT_ROOT}/maintenance.html -f + RewriteCond %{DOCUMENT_ROOT}/maintenance.enable -f + RewriteCond %{SCRIPT_FILENAME} !maintenance.html + RewriteRule ^.*$ /maintenance.html [R=503,L] + ErrorDocument 503 /maintenance.html + Header Set Cache-Control "max-age=0, no-store" -3. Restart Apache: +3. Restart Apache: - * CentOS: `service httpd restart` - * Ubuntu: `service apache2 restart` + * CentOS: `service httpd restart` + * Ubuntu: `service apache2 restart` 4. Enter the following command: - touch /maintenance.enable -5. [Upgrade your system]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). -7. Test your site to make sure it functions correctly. -6. After the upgrade is done, delete `maintenance.enable`. + touch /maintenance.enable +5. [Upgrade your system]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). +7. Test your site to make sure it functions correctly. +6. After the upgrade is done, delete `maintenance.enable`. ## Custom maintenance page for nginx {#compman-trouble-maint-nginx} @@ -102,49 +102,49 @@ This section discusses how to create a custom maintenance page and how to redire To redirect traffic to a custom maintenance page: -1. Use a text editor to open the [nginx](https://glossary.magento.com/nginx) configuration file that contains your server block. -2. Add the following to the server block (`server` is shown for clarity only; don't add a second server block). +1. Use a text editor to open the [nginx](https://glossary.magento.com/nginx) configuration file that contains your server block. +2. Add the following to the server block (`server` is shown for clarity only; don't add a second server block). - The following whitelists IP address 192.0.2.110 and 192.0.2.115 on a system where Magento is installed in `/var/www/html/magento2`: + The following whitelists IP address 192.0.2.110 and 192.0.2.115 on a system where Magento is installed in `/var/www/html/magento2`: - server { - listen 80; - set $MAGE_ROOT /var/www/html/magento2; + server { + listen 80; + set $MAGE_ROOT /var/www/html/magento2; - set $maintenance off; + set $maintenance off; - if (-f $MAGE_ROOT/maintenance.enable) { - set $maintenance on; - } + if (-f $MAGE_ROOT/maintenance.enable) { + set $maintenance on; + } - if ($remote_addr ~ (192.0.2.110|192.0.2.115)) { - set $maintenance off; - } + if ($remote_addr ~ (192.0.2.110|192.0.2.115)) { + set $maintenance off; + } - if ($maintenance = on) { - return 503; - } + if ($maintenance = on) { + return 503; + } - location /maintenance { - } + location /maintenance { + } - error_page 503 @maintenance; + error_page 503 @maintenance; - location @maintenance { - root $MAGE_ROOT; - rewrite ^(.*)$ /maintenance.html break; + location @maintenance { + root $MAGE_ROOT; + rewrite ^(.*)$ /maintenance.html break; - include /var/www/html/magento2/nginx.conf; - } + include /var/www/html/magento2/nginx.conf; + } 4. Enter the following command: - touch /maintenance.enable + touch /maintenance.enable 3. Reload the nginx configuration: - service nginx reload -5. [Upgrade your system]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). -7. Test your site to make sure it functions correctly. -6. After the upgrade is done, delete or rename `maintenance.enable` -5. Reload the nginx configuration: + service nginx reload +5. [Upgrade your system]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). +7. Test your site to make sure it functions correctly. +6. After the upgrade is done, delete or rename `maintenance.enable` +5. Reload the nginx configuration: - service nginx reload + service nginx reload diff --git a/guides/v2.2/comp-mgr/trouble/cman/out-of-memory.md b/guides/v2.2/comp-mgr/trouble/cman/out-of-memory.md index 050398af065..e51c70ed83c 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/out-of-memory.md +++ b/guides/v2.2/comp-mgr/trouble/cman/out-of-memory.md @@ -15,9 +15,9 @@ You may encounter an error, caused by your system running out of physical memory When installing or updating the Magento application or components like extensions, themes, or language packages, an error similar to the following displays: - Could not complete update {"components":[ - {"name":"magento/module-bundle-sample-data","version":"100.1.0"} - ]} successfully: proc_open(): fork failed - Cannot allocate memory + Could not complete update {"components":[ + {"name":"magento/module-bundle-sample-data","version":"100.1.0"} + ]} successfully: proc_open(): fork failed - Cannot allocate memory The error `proc_open(): fork failed - Cannot allocate memory` can also display on the command line. @@ -37,14 +37,14 @@ The following are suggestions only; other options might be available. Consult a Use the `fallocate` command as discussed in these references: -* [How To Add Swap on Ubuntu 14.04 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04){:target="_blank"} -* [How To Add Swap Space on Ubuntu 16.04 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-16-04){:target="_blank"} -* [SwapFaq (help.ubuntu.com)](https://help.ubuntu.com/community/SwapFaq){:target="_blank"} +* [How To Add Swap on Ubuntu 14.04 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-ubuntu-14-04){:target="_blank"} +* [How To Add Swap Space on Ubuntu 16.04 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-16-04){:target="_blank"} +* [SwapFaq (help.ubuntu.com)](https://help.ubuntu.com/community/SwapFaq){:target="_blank"} #### Swap file on CentOS Use the `mkswap` command as discussed in these references: -* [How To Add Swap on CentOS 6 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-centos-6){:target="_blank"} -* [How To Add Swap on CentOS 7 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-centos-7){:target="_blank"} -* [Swap Space (RedHat customer portal)](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ch-swapspace.html){:target="_blank"} +* [How To Add Swap on CentOS 6 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-centos-6){:target="_blank"} +* [How To Add Swap on CentOS 7 (Digitalocean)](https://www.digitalocean.com/community/tutorials/how-to-add-swap-on-centos-7){:target="_blank"} +* [Swap Space (RedHat customer portal)](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ch-swapspace.html){:target="_blank"} diff --git a/guides/v2.2/comp-mgr/trouble/cman/tshoot_backup.md b/guides/v2.2/comp-mgr/trouble/cman/tshoot_backup.md index d3ed373f503..b77bb160883 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/tshoot_backup.md +++ b/guides/v2.2/comp-mgr/trouble/cman/tshoot_backup.md @@ -11,9 +11,9 @@ functional_areas: A backup can fail for any of the following reasons: -* [Insufficient disk space](#trouble-backup-space) -* [An operating system error](#trouble-backup-os) -* [Backup fails](#trouble-backup-all) +* [Insufficient disk space](#trouble-backup-space) +* [An operating system error](#trouble-backup-os) +* [Backup fails](#trouble-backup-all) ## Backup disabled @@ -36,17 +36,17 @@ For additional information on backups, see [Back up and roll back the file syste If the backup failed because of insufficient disk space, you should typically free up disk space by moving some files to another storage device or drive. However, there might be other ways to resolve the issue. See one of the following resources for tips: -* [8 Tips to Solve Linux & Unix Systems Hard Disk Problems Like Disk Full Or Can’t Write to the Disk](http://www.cyberciti.biz/datacenter/linux-unix-bsd-osx-cannot-write-to-hard-disk){:target="_blank"} -* [serverfault: df says disk is full, but it is not](http://serverfault.com/questions/315181/df-says-disk-is-full-but-it-is-not){:target="_blank"} -* [unix.stackexchange.com: Tracking down where disk space has gone on Linux?](http://unix.stackexchange.com/questions/125429/tracking-down-where-disk-space-has-gone-on-linux){:target="_blank"} +* [8 Tips to Solve Linux & Unix Systems Hard Disk Problems Like Disk Full Or Can’t Write to the Disk](http://www.cyberciti.biz/datacenter/linux-unix-bsd-osx-cannot-write-to-hard-disk){:target="_blank"} +* [serverfault: df says disk is full, but it is not](http://serverfault.com/questions/315181/df-says-disk-is-full-but-it-is-not){:target="_blank"} +* [unix.stackexchange.com: Tracking down where disk space has gone on Linux?](http://unix.stackexchange.com/questions/125429/tracking-down-where-disk-space-has-gone-on-linux){:target="_blank"} ## Operating system error {#trouble-backup-os} Unfortunately, we can't recommend anything specific because of the variety of errors you might encounter. We can suggest, however, you: -* Contact your system administrator -* Search public forums like [Stack Exchange](http://unix.stackexchange.com){:target="_blank"} or [Stack Overflow](http://stackoverflow.com){:target="_blank"} -* Open a [GitHub issue](https://github.com/magento/magento2/issues){:target="_blank"} and we'll try to help +* Contact your system administrator +* Search public forums like [Stack Exchange](http://unix.stackexchange.com){:target="_blank"} or [Stack Overflow](http://stackoverflow.com){:target="_blank"} +* Open a [GitHub issue](https://github.com/magento/magento2/issues){:target="_blank"} and we'll try to help ## Backup fails {#trouble-backup-all} diff --git a/guides/v2.2/comp-mgr/trouble/cman/update-fail.md b/guides/v2.2/comp-mgr/trouble/cman/update-fail.md index 8090870d171..0422a5caaf3 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/update-fail.md +++ b/guides/v2.2/comp-mgr/trouble/cman/update-fail.md @@ -11,11 +11,11 @@ functional_areas: If your component update fails, messages similar to the following display in the Console Log: - [2015-08-14 12:12:02 CDT] Job "update {"components":[{"name":"example/module","version":"1.1.0"}]}" has been started - [2015-08-14 12:12:02 CDT] Starting composer update... - [2015-08-14 12:12:02 CDT] An error occurred while executing job "update {"components": - [{"name":"example/module","version":"1.1.0"}]}": Could not complete update {"components": - [{"name":"example/module","version":"1.1.0"}]} successfully: Cannot find component to update + [2015-08-14 12:12:02 CDT] Job "update {"components":[{"name":"example/module","version":"1.1.0"}]}" has been started + [2015-08-14 12:12:02 CDT] Starting composer update... + [2015-08-14 12:12:02 CDT] An error occurred while executing job "update {"components": + [{"name":"example/module","version":"1.1.0"}]}": Could not complete update {"components": + [{"name":"example/module","version":"1.1.0"}]} successfully: Cannot find component to update In the preceding example, there is no component version to which to roll back. Contact the component vendor or try to resolve the issue yourself. diff --git a/guides/v2.2/comp-mgr/trouble/cman/upgrade_51431.md b/guides/v2.2/comp-mgr/trouble/cman/upgrade_51431.md index 33045e82ed3..a9066490394 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/upgrade_51431.md +++ b/guides/v2.2/comp-mgr/trouble/cman/upgrade_51431.md @@ -16,36 +16,36 @@ This section discusses upgrade issues to Magento version 2.0.4. Symptoms include ### `Strict Notice` exception Error text follows: - [Exception] - Strict Notice: Declaration of Magento\Store\Model\ResourceModel\Website\Interceptor::afterLoad() should be compatible with Magento\Framework\Model\ResourceModel\Db\AbstractDb::afterLoad(Magento\Framework\DataObject $object) in /var/www/html/magento2ce/var/generation/Magento/Store/Model/ResourceModel/Website/Interceptor.php on line 7 + [Exception] + Strict Notice: Declaration of Magento\Store\Model\ResourceModel\Website\Interceptor::afterLoad() should be compatible with Magento\Framework\Model\ResourceModel\Db\AbstractDb::afterLoad(Magento\Framework\DataObject $object) in /var/www/html/magento2ce/var/generation/Magento/Store/Model/ResourceModel/Website/Interceptor.php on line 7 ### PHP fatal error A snippet from this error follows: - PHP Fatal error: Cannot instantiate interface Magento\Framework\MessageQueue\ConfigInterface in /var/www/html/eddie/project-enterprise-edition/vendor/magento/framework/ObjectManager/Factory/Dynamic/Developer.php on line 73 - PHP Stack trace: - PHP 1. {main}() /var/www/html/eddie/project-enterprise-edition/bin/magento:0 - PHP 2. Magento\Framework\Console\Cli->__construct() /var/www/html/eddie/project-enterprise-edition/bin/magento:26 - PHP 3. Symfony\Component\Console\Application->__construct() /var/www/html/eddie/project-enterprise-edition/vendor/magento/framework/Console/Cli.php:94 - ... more ... + PHP Fatal error: Cannot instantiate interface Magento\Framework\MessageQueue\ConfigInterface in /var/www/html/eddie/project-enterprise-edition/vendor/magento/framework/ObjectManager/Factory/Dynamic/Developer.php on line 73 + PHP Stack trace: + PHP 1. {main}() /var/www/html/eddie/project-enterprise-edition/bin/magento:0 + PHP 2. Magento\Framework\Console\Cli->__construct() /var/www/html/eddie/project-enterprise-edition/bin/magento:26 + PHP 3. Symfony\Component\Console\Application->__construct() /var/www/html/eddie/project-enterprise-edition/vendor/magento/framework/Console/Cli.php:94 + ... more ... ## Solution To resolve these errors, perform the following tasks: -1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). +1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). - If you don't have access to the Magento server file system, connect to it using an FTP application. -2. Remove the following files so you can upgrade again: + If you don't have access to the Magento server file system, connect to it using an FTP application. +2. Remove the following files so you can upgrade again: - /var/.maintenance.flag - /var/.update_in_progress.flag - /var/cache/* - /var/page_cache/* - /var/generation/* + /var/.maintenance.flag + /var/.update_in_progress.flag + /var/cache/* + /var/page_cache/* + /var/generation/* -3. Run your upgrade again, making sure to complete _all tasks_ discussed in [Run System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). +3. Run your upgrade again, making sure to complete _all tasks_ discussed in [Run System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html). ### `var/session` permissions failure {#compman-upgr-perms} If your Magento application is set to write session data to the `/var/session` directory, you must set permissions on that directory before you upgrade. @@ -54,39 +54,39 @@ If your Magento application is set to write session data to the `/ To verify whether or not sessions are stored in `/var/session`, log in to your Magento server, or switch to, [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html) and enter the following command: - ls /var/session + ls /var/session For example, if Magento is installed in `/var/www/magento2`, enter: - ls /var/www/magento2/var/session + ls /var/www/magento2/var/session If there are files in that directory, you must set permissions; if there are no files in that directory, you can skip the remainder of this topic and continue with [Step 4. Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade.html). To set file system permissions before upgrade: -1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). -2. Enter one of the following commands: +1. Log in to your Magento server as, or switch to, the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). +2. Enter one of the following commands: - * One Magento user (typical of shared hosting): + * One Magento user (typical of shared hosting): - cd - find var -type f -exec chmod u+w {} + - find var -type d -exec chmod u+w {} + + cd + find var -type f -exec chmod u+w {} + + find var -type d -exec chmod u+w {} + - If you don't have access to a command line, use a file manager tool provided by your hosting provider to set permissions. + If you don't have access to a command line, use a file manager tool provided by your hosting provider to set permissions. - * Two Magento users: + * Two Magento users: - cd - find var -type f -exec chmod g+w {} + - find var -type d -exec chmod g+ws {} + - chown -R : . + cd + find var -type f -exec chmod g+w {} + + find var -type d -exec chmod g+ws {} + + chown -R : . - For example, on CentOS where the web server group is typically `apache`: + For example, on CentOS where the web server group is typically `apache`: - cd /var/www/html/magento2 - find var -type f -exec chmod g+w {} + - find var -type d -exec chmod g+ws {} + - chown -R :apache . + cd /var/www/html/magento2 + find var -type f -exec chmod g+w {} + + find var -type d -exec chmod g+ws {} + + chown -R :apache . For additional details about file ownership and permissions, see [Set pre-installation ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-system-perms.html). diff --git a/guides/v2.2/comp-mgr/trouble/cman/were-sorry.md b/guides/v2.2/comp-mgr/trouble/cman/were-sorry.md index 5325f669391..4ea59763a79 100644 --- a/guides/v2.2/comp-mgr/trouble/cman/were-sorry.md +++ b/guides/v2.2/comp-mgr/trouble/cman/were-sorry.md @@ -15,9 +15,9 @@ The following error might display at the start of your upgrade: See one of the following sections for possible solutions: -* [Problem: you're not authenticated](#not-auth) -* [Problem: the updater application isn't initialized](#updater) -* [Problem: you cloned the Magento GitHub repository](#git-clone) +* [Problem: you're not authenticated](#not-auth) +* [Problem: the updater application isn't initialized](#updater) +* [Problem: you cloned the Magento GitHub repository](#git-clone) ### Problem: you're not authenticated {#not-auth} @@ -39,35 +39,35 @@ The updater application uses a cron job to run the upgrade; if it's not initiali Modify Magento's `composer.json` to reference the `https://repo.magento.com` repository and run `composer install` in the updater's root directory to resolve dependencies and initialize it as follows: -1. Log in to your Magento server as the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). -2. Change to your Magento installation directory. -3. Back up your existing `composer.json`: +1. Log in to your Magento server as the [Magento file system owner]({{ page.baseurl }}/install-gde/prereq/apache-user.html). +2. Change to your Magento installation directory. +3. Back up your existing `composer.json`: - cp composer.json composer.json.bak + cp composer.json composer.json.bak -4. Open `composer.json` in a text editor. -5. To the `repositories` section, add the following: +4. Open `composer.json` in a text editor. +5. To the `repositories` section, add the following: - { - "type": "composer", - "url": "https://repo.magento.com/" - } + { + "type": "composer", + "url": "https://repo.magento.com/" + } Example: - "repositories": [ - { - "type": "composer", - "url": "https://repo.magento.com/" - } - ] + "repositories": [ + { + "type": "composer", + "url": "https://repo.magento.com/" + } + ] -6. Save your changes to `composer.json` and exit the text editor. -7. Change to the `update` subdirectory, where the updater is located. -8. Enter the following command: +6. Save your changes to `composer.json` and exit the text editor. +7. Change to the `update` subdirectory, where the updater is located. +8. Enter the following command: - composer install -9. After the command completes, try the upgrade again. + composer install +9. After the command completes, try the upgrade again. ### You cloned the Magento GitHub repository {#git-clone} diff --git a/guides/v2.2/comp-mgr/trouble/tshoot.md b/guides/v2.2/comp-mgr/trouble/tshoot.md index d99b2dc63d0..807bf42f999 100644 --- a/guides/v2.2/comp-mgr/trouble/tshoot.md +++ b/guides/v2.2/comp-mgr/trouble/tshoot.md @@ -13,15 +13,15 @@ The following topics discuss Component Manager and System Upgrade errors and sug ### Both Component Manager and System Upgrade -* [Troubleshoot cron]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) -* [Troubleshoot component dependencies]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) -* [Troubleshoot the updater application]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) -* [Troubleshoot backup]({{ page.baseurl }}/comp-mgr/trouble/cman/tshoot_backup.html) +* [Troubleshoot cron]({{ page.baseurl }}/comp-mgr/trouble/cman/cron.html) +* [Troubleshoot component dependencies]({{ page.baseurl }}/comp-mgr/trouble/cman/component-depend.html) +* [Troubleshoot the updater application]({{ page.baseurl }}/comp-mgr/trouble/cman/updater.html) +* [Troubleshoot backup]({{ page.baseurl }}/comp-mgr/trouble/cman/tshoot_backup.html) ### System Upgrade only -* ["Sorry, we can't take that action right now"]({{ page.baseurl }}/comp-mgr/trouble/cman/were-sorry.html) -* [Missing .gitignore files]({{ page.baseurl }}/comp-mgr/trouble/cman/gitignore.html) -* [Roll back after upgrade failure]({{ page.baseurl }}/comp-mgr/trouble/cman/update-fail.html) -* [CE to EE upgrade failure]({{ page.baseurl }}/comp-mgr/trouble/cman/ce-ee-upgrade.html) +* ["Sorry, we can't take that action right now"]({{ page.baseurl }}/comp-mgr/trouble/cman/were-sorry.html) +* [Missing .gitignore files]({{ page.baseurl }}/comp-mgr/trouble/cman/gitignore.html) +* [Roll back after upgrade failure]({{ page.baseurl }}/comp-mgr/trouble/cman/update-fail.html) +* [CE to EE upgrade failure]({{ page.baseurl }}/comp-mgr/trouble/cman/ce-ee-upgrade.html) diff --git a/guides/v2.2/comp-mgr/updater/update-updater.md b/guides/v2.2/comp-mgr/updater/update-updater.md index 9ab09d2c228..452dcabcf1a 100644 --- a/guides/v2.2/comp-mgr/updater/update-updater.md +++ b/guides/v2.2/comp-mgr/updater/update-updater.md @@ -16,13 +16,13 @@ To update the updater application: 1. Delete, move, or rename the directory containing the updater application. ```bash - mv /update /old_update - ``` + mv /update /old_update + ``` 1. Change to your Magento 2 installation directory and enter the following command: - ```bash - composer create-project magento/updater update --repository https://repo.magento.com - ``` + ```bash + composer create-project magento/updater update --repository https://repo.magento.com + ``` 1. If prompted, enter your Magento [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html). 1. Wait while [Composer](https://glossary.magento.com/composer) installs the updater and its dependencies. diff --git a/guides/v2.2/comp-mgr/upgrader/ce-ee-upgrade-start.md b/guides/v2.2/comp-mgr/upgrader/ce-ee-upgrade-start.md index 5dea51eb87d..1a1694870c1 100644 --- a/guides/v2.2/comp-mgr/upgrader/ce-ee-upgrade-start.md +++ b/guides/v2.2/comp-mgr/upgrader/ce-ee-upgrade-start.md @@ -23,13 +23,13 @@ Make sure you are authorized for {{site.data.var.ee}} access before you continue To run System Upgrade: -1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. -2. Click **System** > **Web Setup Wizard**. - The following page displays. +1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. +2. Click **System** > **Web Setup Wizard**. + The following page displays. ![Specify whether to manage components or upgrade Magento] -3. Click **System Upgrade**. +3. Click **System Upgrade**. Magento begins searching for core module updates immediately. To also search for component updates, click **Yes**. A sample follows: @@ -57,20 +57,20 @@ After the upgrade completes: #### Errors -* The following error can indicate one of several issues, including that you haven't entered your [authentication keys] in the Magento Admin: +* The following error can indicate one of several issues, including that you haven't entered your [authentication keys] in the Magento Admin: - ![Sorry we can't take that action right now] + ![Sorry we can't take that action right now] For suggested solutions to other causes indicated by this message, see [troubleshooting]. -* The following error might display: +* The following error might display: - [2016-01-19 23:33:24 UTC] An error occurred while executing job - "setup:upgrade {"command":"setup:upgrade"}": Could not complete - setup:upgrade {"command":"setup:upgrade"} successfully: Source - class "\Cybersource" for "CybersourceLogger" generation does not exist. + [2016-01-19 23:33:24 UTC] An error occurred while executing job + "setup:upgrade {"command":"setup:upgrade"}": Could not complete + setup:upgrade {"command":"setup:upgrade"} successfully: Source + class "\Cybersource" for "CybersourceLogger" generation does not exist. - For more information, see [Error upgrading from CE to EE]. + For more information, see [Error upgrading from CE to EE]. ## Continue your upgrade {#ce-ee-continue} diff --git a/guides/v2.2/comp-mgr/upgrader/upgrade-checklist.md b/guides/v2.2/comp-mgr/upgrader/upgrade-checklist.md index 80c051b7889..ca6f55f5fae 100644 --- a/guides/v2.2/comp-mgr/upgrader/upgrade-checklist.md +++ b/guides/v2.2/comp-mgr/upgrader/upgrade-checklist.md @@ -15,12 +15,12 @@ This section discusses how to start System Upgrade, which upgrades the version o You can upgrade in any of the following ways: -* Using the System Upgrade utility, a wizard that walks you through the upgrade step by step; continue with this topic. +* Using the System Upgrade utility, a wizard that walks you through the upgrade step by step; continue with this topic. - Use this method if you don't have a to the Magento server's file system or if you're a non-technical user. -* Using the [command line]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html). + Use this method if you don't have a to the Magento server's file system or if you're a non-technical user. +* Using the [command line]({{ page.baseurl }}/comp-mgr/cli/cli-upgrade.html). - This upgrade method is more advanced and it requires access to the Magento server's file system. + This upgrade method is more advanced and it requires access to the Magento server's file system. {:.bs-callout .bs-callout-info} _System upgrade_ refers to updating the Magento 2.x core components and other installed components. To migrate from Magento 1.x to Magento 2, see the [Migration Guide]({{ page.baseurl }}/migration/bk-migration-guide.html). diff --git a/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md b/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md index 16ffe3ba922..df9d50639b8 100644 --- a/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md +++ b/guides/v2.2/comp-mgr/upgrader/upgrade-main-pg.md @@ -13,72 +13,72 @@ functional_areas: To choose which components to upgrade: -1. After you [run System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html), a page similar to the following displays:

    - System Upgrade automatically checks for core module updates and third-party modules if you wish -2. You have the following options: - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ItemMeaning

    Try Again, Next

    Click Try Again to search for upgrades again. You can do this if something recently changed.

    -

    Click Next to continue to the readiness check after making selections on this page.

    Magento Core Components list

    Displays available core component versions for upgrade.

    -

    (current) indicates the version you currently have.

    -

    (latest) indicates the most recent available version for upgrade.

    Other Components button

    Enables you to search for upgrades for third-party components.

    -
    • To search for available component updates, click Yes.
      • -
    • To search only for Magento core component upgrades, click No.

    Pagination

    Enables you to:

    -

    Specify number of items to display on pageSpecify the number of items to display on a page.

    -

    Move back and forward or specify a page numberFrom left to right, move back one page, go to a specific page, or move forward one page.

    List of components

    For each component, you can:

    -
    • Set Upgrade to Yes to upgrade it.
      • -
    • Set Upgrade to No to skip it (that is, not upgrade that component).
      • -
    • From the Update Version list, click the upgrade version. (If you already have the most current version, the list has only one option.)
    -
    +1. After you [run System Upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-start.html), a page similar to the following displays:

    + System Upgrade automatically checks for core module updates and third-party modules if you wish +2. You have the following options: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ItemMeaning

    Try Again, Next

    Click Try Again to search for upgrades again. You can do this if something recently changed.

    +

    Click Next to continue to the readiness check after making selections on this page.

    Magento Core Components list

    Displays available core component versions for upgrade.

    +

    (current) indicates the version you currently have.

    +

    (latest) indicates the most recent available version for upgrade.

    Other Components button

    Enables you to search for upgrades for third-party components.

    +
    • To search for available component updates, click Yes.
      • +
    • To search only for Magento core component upgrades, click No.

    Pagination

    Enables you to:

    +

    Specify number of items to display on pageSpecify the number of items to display on a page.

    +

    Move back and forward or specify a page numberFrom left to right, move back one page, go to a specific page, or move forward one page.

    List of components

    For each component, you can:

    +
    • Set Upgrade to Yes to upgrade it.
      • +
    • Set Upgrade to No to skip it (that is, not upgrade that component).
      • +
    • From the Update Version list, click the upgrade version. (If you already have the most current version, the list has only one option.)
    +
    ## Upgrade components {#upgr-comps} To upgrade components: -1. From the **Magento Core Components** list, click the core component version to which to upgrade. +1. From the **Magento Core Components** list, click the core component version to which to upgrade. - For example, to upgrade to the latest version, click the one with **(latest)** in the name as the following figure shows. + For example, to upgrade to the latest version, click the one with **(latest)** in the name as the following figure shows. - ![Select the version of Magento core components to which to upgrade]({{ site.baseurl }}/common/images/upgr_step1_core-ver.png) + ![Select the version of Magento core components to which to upgrade]({{ site.baseurl }}/common/images/upgr_step1_core-ver.png) -2. For each third-party component: +2. For each third-party component: - * If you *do* want to upgrade it, set **Upgrade** to **Yes** and click the version from the **Update Version** list. + * If you *do* want to upgrade it, set **Upgrade** to **Yes** and click the version from the **Update Version** list. - A sample follows. + A sample follows. - ![Upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_yes.png) + ![Upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_yes.png) - * If you *do not* want to upgrade it, set **Upgrade** to **No**. + * If you *do not* want to upgrade it, set **Upgrade** to **No**. - A sample follows. + A sample follows. - ![Do not upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_no.png) + ![Do not upgrade this component]({{ site.baseurl }}/common/images/upgr_comp_no.png) -3. Click **Next** and continue with [Step 2. Readiness check]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-readiness.html) +3. Click **Next** and continue with [Step 2. Readiness check]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-readiness.html) diff --git a/guides/v2.2/comp-mgr/upgrader/upgrade-start.md b/guides/v2.2/comp-mgr/upgrader/upgrade-start.md index eebba845543..cdfd5ac2e47 100644 --- a/guides/v2.2/comp-mgr/upgrader/upgrade-start.md +++ b/guides/v2.2/comp-mgr/upgrader/upgrade-start.md @@ -23,30 +23,30 @@ To avoid the appearance of a disabled site and to set up a custom maintenance pa To run System Upgrade: -1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. -2. Click **System** > **Tools** > **Web Setup Wizard**. - The following page displays.

    - ![Specify whether to manage components or upgrade Magento]({{ site.baseurl }}/common/images/cman_upgr_initial.png) -3. Click **System Configuration**. -4. If you haven't already done so, enter your [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. +1. Log in to the [Magento Admin](https://glossary.magento.com/magento-admin) as an administrator. +2. Click **System** > **Tools** > **Web Setup Wizard**. + The following page displays.

    + ![Specify whether to manage components or upgrade Magento]({{ site.baseurl }}/common/images/cman_upgr_initial.png) +3. Click **System Configuration**. +4. If you haven't already done so, enter your [authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. - The following figure shows an example if you *have* already entered your keys. + The following figure shows an example if you *have* already entered your keys. - ![Authentication keys entered in the Setup Wizard]({{ site.baseurl }}/common/images/compman_auth-keys.png) + ![Authentication keys entered in the Setup Wizard]({{ site.baseurl }}/common/images/compman_auth-keys.png) - {:.bs-callout .bs-callout-warning} - For upgrade or update, you must use the same authentication keys you used to install the Magento software. For example, you *cannot* use {{site.data.var.ce}} authentication keys to update or upgrade Magento EE or vice versa. You also *cannot* use another user's authentication keys or [Shared account](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html) authentication keys + {:.bs-callout .bs-callout-warning} + For upgrade or update, you must use the same authentication keys you used to install the Magento software. For example, you *cannot* use {{site.data.var.ce}} authentication keys to update or upgrade Magento EE or vice versa. You also *cannot* use another user's authentication keys or [Shared account](http://docs.magento.com/m2/ce/user_guide/magento/magento-account-share.html) authentication keys -5. Click **Save Config**. -3. Click **System Upgrade**. +5. Click **Save Config**. +3. Click **System Upgrade**. - Magento begins searching for core module updates immediately. To also search for component updates, click **Yes**. A sample follows: + Magento begins searching for core module updates immediately. To also search for component updates, click **Yes**. A sample follows: - ![Magento begins searching for upgrades right away]({{ site.baseurl }}/common/images/upgr_initial-pg.png) + ![Magento begins searching for upgrades right away]({{ site.baseurl }}/common/images/upgr_initial-pg.png) - The page displays similar to the following when we find components to upgrade.

    - ![Magento finds software to upgrade]({{ site.baseurl }}/common/images/upgr_stuff-2-upgrade.png)

    -4. Continue with [Step 1. Select versions to upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-main-pg.html). + The page displays similar to the following when we find components to upgrade.

    + ![Magento finds software to upgrade]({{ site.baseurl }}/common/images/upgr_stuff-2-upgrade.png)

    +4. Continue with [Step 1. Select versions to upgrade]({{ page.baseurl }}/comp-mgr/upgrader/upgrade-main-pg.html). #### Error @@ -60,5 +60,5 @@ For suggested solutions to other causes indicated by this message, see [troubles The System Upgrade utility installs sample data for you but doesn't display it, if you: -* Used the [`magento sampledata:deploy`]({{ page.baseurl }}/install-gde/install/cli/install-cli-sample-data-composer.html) command to download, but not installed sample data -* You chose to update components at the same time as the Magento system software +* Used the [`magento sampledata:deploy`]({{ page.baseurl }}/install-gde/install/cli/install-cli-sample-data-composer.html) command to download, but not installed sample data +* You chose to update components at the same time as the Magento system software diff --git a/guides/v2.2/comp-mgr/upgrader/upgrade.md b/guides/v2.2/comp-mgr/upgrader/upgrade.md index 945348adcba..f6818ae32b5 100644 --- a/guides/v2.2/comp-mgr/upgrader/upgrade.md +++ b/guides/v2.2/comp-mgr/upgrader/upgrade.md @@ -37,15 +37,15 @@ bin/magento cache:clean After the upgrade completes, manually clear `var` subdirectories: - rm -rf /var/cache/* - rm -rf /var/page_cache/* - rm -rf /generated/code/* + rm -rf /var/cache/* + rm -rf /var/page_cache/* + rm -rf /generated/code/* ## Restart Varnish After the upgrade completes, restart Varnish if you use it for page caching. - service varnish restart + service varnish restart Then access your [storefront](https://glossary.magento.com/storefront) and verify everything is working properly. @@ -53,12 +53,12 @@ Then access your [storefront](https://glossary.magento.com/storefront) and verif After you finish your upgrade, errors might display. -* On the main storefront page, the following error might display. +* On the main storefront page, the following error might display. - We're sorry, an error has occurred while generating this email. -* On a [category](https://glossary.magento.com/category) page, the following error might display: + We're sorry, an error has occurred while generating this email. +* On a [category](https://glossary.magento.com/category) page, the following error might display: - We can't find products matching the selection. + We can't find products matching the selection. If any of the preceding errors display, perform all of the following tasks. @@ -66,11 +66,11 @@ If any of the preceding errors display, perform all of the following tasks. ### Clear `var` and `generated` directories -Clear the `var/cache`, `var/page_cache`, `generated/code` +Clear the `var/cache`, `var/page_cache`, `generated/code` A sample command follows: - rm -rf var/cache/* var/page_cache/* generated/code/* + rm -rf var/cache/* var/page_cache/* generated/code/* ### Access your storefront again diff --git a/guides/v2.2/config-guide/bk-config-guide.md b/guides/v2.2/config-guide/bk-config-guide.md index 42722f6b957..208688f63f1 100644 --- a/guides/v2.2/config-guide/bk-config-guide.md +++ b/guides/v2.2/config-guide/bk-config-guide.md @@ -11,33 +11,33 @@ functional_areas: You can configure the Magento application in any of the following ways: -* General configuration +* General configuration - * Using a [command-line utility]({{ page.baseurl }}/config-guide/cli/config-cli.html) (for example, enable or disable cache types, run indexers, set up translations, and so on) - * Manually to set up [bootstrap parameters]({{ page.baseurl }}/config-guide/bootstrap/magento-bootstrap.html) + * Using a [command-line utility]({{ page.baseurl }}/config-guide/cli/config-cli.html) (for example, enable or disable cache types, run indexers, set up translations, and so on) + * Manually to set up [bootstrap parameters]({{ page.baseurl }}/config-guide/bootstrap/magento-bootstrap.html) -* Caching +* Caching - * [Set up Varnish]({{ page.baseurl }}/config-guide/varnish/config-varnish.html) - * [Set up caching]({{ page.baseurl }}/config-guide/cache.html) - * [Use Redis for the Magento page and default cache]({{ page.baseurl }}/config-guide/redis/redis-pg-cache.html) - * [Use Redis for session storage]({{ page.baseurl }}/config-guide/redis/redis-session.html) - * [Set up database caching]({{ page.baseurl }}/extension-dev-guide/cache/partial-caching/database-caching.html) + * [Set up Varnish]({{ page.baseurl }}/config-guide/varnish/config-varnish.html) + * [Set up caching]({{ page.baseurl }}/config-guide/cache.html) + * [Use Redis for the Magento page and default cache]({{ page.baseurl }}/config-guide/redis/redis-pg-cache.html) + * [Use Redis for session storage]({{ page.baseurl }}/config-guide/redis/redis-session.html) + * [Set up database caching]({{ page.baseurl }}/extension-dev-guide/cache/partial-caching/database-caching.html) -* Magento in production +* Magento in production - * [pipeline deployment]({{ page.baseurl }}/config-guide/deployment/pipeline/) - * [Magento ownership and permissions in development and production]({{ page.baseurl }}/config-guide/prod/prod_file-sys-perms.html) - * [Single machine deployment]({{ page.baseurl }}/config-guide/deployment/single-machine.html) + * [pipeline deployment]({{ page.baseurl }}/config-guide/deployment/pipeline/) + * [Magento ownership and permissions in development and production]({{ page.baseurl }}/config-guide/prod/prod_file-sys-perms.html) + * [Single machine deployment]({{ page.baseurl }}/config-guide/deployment/single-machine.html) -* Session storage - * [memcache]({{ page.baseurl }}/config-guide/memcache/memcache.html) - * [Redis]({{ page.baseurl }}/config-guide/redis/redis-session.html) - * [How to locate session files]({{ page.baseurl }}/config-guide/sessions.html) +* Session storage + * [memcache]({{ page.baseurl }}/config-guide/memcache/memcache.html) + * [Redis]({{ page.baseurl }}/config-guide/redis/redis-session.html) + * [How to locate session files]({{ page.baseurl }}/config-guide/sessions.html) -* {{site.data.var.ee}} only +* {{site.data.var.ee}} only - * [Install and configure Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/es-overview.html) - * [Split databases]({{ page.baseurl }}/config-guide/multi-master/multi-master.html) - * [Message queues]({{ page.baseurl }}/config-guide/mq/rabbitmq-overview.html) - * [Set up Magento B2B]({{ page.baseurl }}/cloud/configure/setup-b2b.html) + * [Install and configure Elasticsearch]({{ page.baseurl }}/config-guide/elasticsearch/es-overview.html) + * [Split databases]({{ page.baseurl }}/config-guide/multi-master/multi-master.html) + * [Message queues]({{ page.baseurl }}/config-guide/mq/rabbitmq-overview.html) + * [Set up Magento B2B]({{ page.baseurl }}/cloud/configure/setup-b2b.html) diff --git a/guides/v2.2/config-guide/bootstrap/mage-dirs.md b/guides/v2.2/config-guide/bootstrap/mage-dirs.md index 98ad8ed053b..85de7f5470f 100644 --- a/guides/v2.2/config-guide/bootstrap/mage-dirs.md +++ b/guides/v2.2/config-guide/bootstrap/mage-dirs.md @@ -17,26 +17,26 @@ Specify an associative array where keys are constants from [\\Magento\\App\\File You can set `MAGE_DIRS` in any of the following ways: -* [Set the value of bootstrap parameters]({{ page.baseurl }}/config-guide/bootstrap/magento-how-to-set.html) -* Use a custom entry point script such as the following: - - ```php?start_inline=1 - use Magento\Framework\App\Filesystem\DirectoryList; - use Magento\Framework\App\Bootstrap; - - require __DIR__ . '/app/bootstrap.php'; - $params = $_SERVER; - $params[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS] = [ - DirectoryList::PUB => [DirectoryList::URL_PATH => '', - DirectoryList::MEDIA => [DirectoryList::PATH => '/mnt/nfs/media', DirectoryList::URL_PATH => ''], - DirectoryList::STATIC_VIEW => [DirectoryList::URL_PATH => 'static'], - DirectoryList::UPLOAD => [DirectoryList::URL_PATH => '/mnt/nfs/media/upload'], - DirectoryList::CACHE => [DirectoryList::PATH => '/mnt/nfs/cache'], - ]; - $bootstrap = \Magento\Framework\App\Bootstrap::create(BP, $params); - /** @var \Magento\Framework\App\Http $app */ - $app = $bootstrap->createApplication('Magento\Framework\App\Http'); - $bootstrap->run($app); - ``` +* [Set the value of bootstrap parameters]({{ page.baseurl }}/config-guide/bootstrap/magento-how-to-set.html) +* Use a custom entry point script such as the following: + + ```php?start_inline=1 + use Magento\Framework\App\Filesystem\DirectoryList; + use Magento\Framework\App\Bootstrap; + + require __DIR__ . '/app/bootstrap.php'; + $params = $_SERVER; + $params[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS] = [ + DirectoryList::PUB => [DirectoryList::URL_PATH => '', + DirectoryList::MEDIA => [DirectoryList::PATH => '/mnt/nfs/media', DirectoryList::URL_PATH => ''], + DirectoryList::STATIC_VIEW => [DirectoryList::URL_PATH => 'static'], + DirectoryList::UPLOAD => [DirectoryList::URL_PATH => '/mnt/nfs/media/upload'], + DirectoryList::CACHE => [DirectoryList::PATH => '/mnt/nfs/cache'], + ]; + $bootstrap = \Magento\Framework\App\Bootstrap::create(BP, $params); + /** @var \Magento\Framework\App\Http $app */ + $app = $bootstrap->createApplication('Magento\Framework\App\Http'); + $bootstrap->run($app); + ``` The preceding example sets paths for `[cache]` and `[media]` directories to `/mnt/nfs/cache` and `/mnt/nfs/media`, respectively. diff --git a/guides/v2.2/config-guide/bootstrap/mage-profiler.md b/guides/v2.2/config-guide/bootstrap/mage-profiler.md index 5c7b90ca4ea..de6e7a7c66e 100644 --- a/guides/v2.2/config-guide/bootstrap/mage-profiler.md +++ b/guides/v2.2/config-guide/bootstrap/mage-profiler.md @@ -11,11 +11,11 @@ Magento profiling enables you to: - Enable a built-in profiler. - You can use a built-in profiler with Magento to perform tasks such as analyzing performance. The nature of profiling depends on the analytical tools you use. We support multiple formats, including HTML. When you enable the profiler, a `var/profiler.flag` file generates indicating the profiler is enabled and configurations. When disabled, this file is deleted. + You can use a built-in profiler with Magento to perform tasks such as analyzing performance. The nature of profiling depends on the analytical tools you use. We support multiple formats, including HTML. When you enable the profiler, a `var/profiler.flag` file generates indicating the profiler is enabled and configurations. When disabled, this file is deleted. - Display dependency graphs on a Magento page. A *dependency graph* is a list of object dependencies and all of their all their dependencies, and all the dependencies for those dependencies, and so on. - You should be particularly interested in the list of *unused dependencies*, which are objects that were created because they were requested in some constructor, but were never used (that is, none of their methods were called). As a result, processor time and memory spent to create these dependencies are wasted. + You should be particularly interested in the list of *unused dependencies*, which are objects that were created because they were requested in some constructor, but were never used (that is, none of their methods were called). As a result, processor time and memory spent to create these dependencies are wasted. Magento provides the base functionality in [Magento\\Framework\\Profiler]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Profiler.php). @@ -29,16 +29,16 @@ You can set the value of `MAGE_PROFILER` in any of the ways discussed in [Set th - `1` to enable a specific profiler's output. - You can also use one of the following values to enable a specific profiler: + You can also use one of the following values to enable a specific profiler: - `csvfile` which uses [Magento\\Framework\\Profiler\\Driver\\Standard\\Output\\Csvfile]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Profiler/Driver/Standard/Output/Csvfile.php) - Any other value (except `2`), including an empty value, which uses [Magento\\Framework\\Profiler\\Driver\\Standard\\Output\\Html]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/Profiler/Driver/Standard/Output/Html.php) - `2` to enable dependency graphs. - Dependency graphs typically display at the bottom of a page. The following figure shows portion of the output: + Dependency graphs typically display at the bottom of a page. The following figure shows portion of the output: - ![]({{ site.baseurl }}/common/images/config_depend-graphs.png) + ![]({{ site.baseurl }}/common/images/config_depend-graphs.png) ## CLI commands {#cli} diff --git a/guides/v2.2/config-guide/bootstrap/magento-bootstrap.md b/guides/v2.2/config-guide/bootstrap/magento-bootstrap.md index 1ca2db5acfd..89e94cb0ae7 100644 --- a/guides/v2.2/config-guide/bootstrap/magento-bootstrap.md +++ b/guides/v2.2/config-guide/bootstrap/magento-bootstrap.md @@ -11,26 +11,26 @@ functional_areas: To run the Magento application, the following actions are implemented in [index.php]({{ site.mage2bloburl }}/{{ page.guide_version }}/index.php){:target="_blank"}: -* Include [app/bootstrap.php]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/bootstrap.php){:target="_blank"} which performs essential initialization routines, such as error handling, initializing the autoloader, setting profiling options, setting the default timezone, and so on. -* Create an instance of [\Magento\Framework\App\Bootstrap]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/App/Bootstrap.php){:target="_blank"}. -* Create a Magento application instance ([\Magento\Framework\AppInterface]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/AppInterface.php){:target="_blank"}). -* Run Magento +* Include [app/bootstrap.php]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/bootstrap.php){:target="_blank"} which performs essential initialization routines, such as error handling, initializing the autoloader, setting profiling options, setting the default timezone, and so on. +* Create an instance of [\Magento\Framework\App\Bootstrap]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/App/Bootstrap.php){:target="_blank"}. +* Create a Magento application instance ([\Magento\Framework\AppInterface]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/AppInterface.php){:target="_blank"}). +* Run Magento ## Bootstrap run logic {#config-boot-logic} [The bootstrap object]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/bootstrap.php){:target="_blank"} uses the following algorithm to run the Magento application: -1. Initializes the error handler. -2. Creates the [object manager]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/ObjectManager){:target="_blank"} and basic shared services that are used everywhere and are affected by the environment. The environment parameters are injected properly into these objects. -3. Asserts that maintenance mode is *not* enabled; otherwise, terminates. -4. Asserts that the Magento application is installed; otherwise, terminates. -5. Starts the Magento application. +1. Initializes the error handler. +2. Creates the [object manager]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/ObjectManager){:target="_blank"} and basic shared services that are used everywhere and are affected by the environment. The environment parameters are injected properly into these objects. +3. Asserts that maintenance mode is *not* enabled; otherwise, terminates. +4. Asserts that the Magento application is installed; otherwise, terminates. +5. Starts the Magento application. - Any uncaught exception during application launch is automatically passed back to Magento in the `catchException()` method which you can use to handle the exception. The latter must return either `true` or `false`: + Any uncaught exception during application launch is automatically passed back to Magento in the `catchException()` method which you can use to handle the exception. The latter must return either `true` or `false`: - * If `true`: Magento handled exception successfully. No need to do anything else. - * If `false` (or any other empty result): Magento did not handle the exception. The bootstrap object performs the default exception handling subroutine. -6. Sends the response provided by the application object. + * If `true`: Magento handled exception successfully. No need to do anything else. + * If `false` (or any other empty result): Magento did not handle the exception. The bootstrap object performs the default exception handling subroutine. +6. Sends the response provided by the application object. {:.bs-callout .bs-callout-info} The assertions that the Magento application is installed and not in maintenance mode is the default behavior of the `\Magento\Framework\App\Bootstrap` class. You can modify it using an entry point script when creating the bootstrap object. @@ -56,33 +56,33 @@ $bootstrap->run($app); The bootstrap object specifies how the Magento application handles uncaught exceptions as follows: -* In [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode), displays the [exception](https://glossary.magento.com/exception) as-is. -* In any other mode, attempts to log exception and display a generic error message. -* Terminates Magento with error code `1` +* In [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode), displays the [exception](https://glossary.magento.com/exception) as-is. +* In any other mode, attempts to log exception and display a generic error message. +* Terminates Magento with error code `1` ## Entry point applications {#config-boot-entry} We have the following entry point applications (that is, applications defined by Magento that are used by the web server as a directory index): -* [HTTP entry point](#config-boot-entry-http) -* [Static resource entry point](#config-boot-entry-static) -* [Media resource entry point](#config-boot-entry-media) +* [HTTP entry point](#config-boot-entry-http) +* [Static resource entry point](#config-boot-entry-static) +* [Media resource entry point](#config-boot-entry-media) ### HTTP entry point {#config-boot-entry-http} [\Magento\Framework\App\Http]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/App/Http){:target="_blank"} operates as follows: -1. Determines the [application area]({{ page.baseurl }}/architecture/archi_perspectives/components/modules/mod_and_areas.html). -2. Starts the front controller and routing systems in order to find and execute a controller action. -3. Uses an HTTP response object to return result obtained from the controller action. -4. Error handling (in the following priority order): - 1. If you're using [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode): - * If the Magento application is not installed, redirect to Setup Wizard. - * If the Magento application is installed, display an error and HTTP status code 500 (Internal Server Error). - 2. If the Magento application is in maintenance mode, display a user-friendly "Service Unavailable" landing page with HTTP status code 503 (Service Temporary Unavailable). - 3. If the Magento application is *not* installed, redirect to Setup Wizard. - 4. If the session is invalid, redirect to the home page. - 5. If there is any other application initialization error, display a user-friendly "Page Not Found" page with HTTP status code 404 (Not Found). - 6. On any other error, display a user-friendly "Service Unavailable" page with HTTP response 503 and generate an error report and display its ID on the page. +1. Determines the [application area]({{ page.baseurl }}/architecture/archi_perspectives/components/modules/mod_and_areas.html). +2. Starts the front controller and routing systems in order to find and execute a controller action. +3. Uses an HTTP response object to return result obtained from the controller action. +4. Error handling (in the following priority order): + 1. If you're using [developer mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#developer-mode): + * If the Magento application is not installed, redirect to Setup Wizard. + * If the Magento application is installed, display an error and HTTP status code 500 (Internal Server Error). + 2. If the Magento application is in maintenance mode, display a user-friendly "Service Unavailable" landing page with HTTP status code 503 (Service Temporary Unavailable). + 3. If the Magento application is *not* installed, redirect to Setup Wizard. + 4. If the session is invalid, redirect to the home page. + 5. If there is any other application initialization error, display a user-friendly "Page Not Found" page with HTTP status code 404 (Not Found). + 6. On any other error, display a user-friendly "Service Unavailable" page with HTTP response 503 and generate an error report and display its ID on the page. ### Static resource entry point {#config-boot-entry-static} [\Magento\Framework\App\StaticResource]({{ site.mage2bloburl }}/{{ page.guide_version }}/lib/internal/Magento/Framework/App/StaticResource.php){:target="_blank"} is an application for retrieving static resources (for example, CSS, JavaScript, and images). It postpones any actions with a static resource until the resource is requested. @@ -93,10 +93,10 @@ The entry point for static view files is not used in [production mode]({{ page.b In default or developer mode, a request for a non-existent static resource is redirected to the static entry point according to the rewrite rules specified by the appropriate `.htaccess`. When the request is redirected to the entry point, the Magento application parses the requested [URL](https://glossary.magento.com/url) based on retrieved parameters and finds the requested resource. -* In developer mode, the content of the file is returned so that every time the resource is requested, the returned content is up to date. -* In [default]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#default-mode) mode, the retrieved resource is published so it is accessible by the previously requested URL. +* In developer mode, the content of the file is returned so that every time the resource is requested, the returned content is up to date. +* In [default]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html#default-mode) mode, the retrieved resource is published so it is accessible by the previously requested URL. - All future requests for the static resource are processed by the server the same as static files; that is, without involving the entry point. If it's necessary to synchronize published files with original ones, the `pub/static` directory should be removed; as a result, files are automatically republished with the next request. + All future requests for the static resource are processed by the server the same as static files; that is, without involving the entry point. If it's necessary to synchronize published files with original ones, the `pub/static` directory should be removed; as a result, files are automatically republished with the next request. ### Media resource entry point {#config-boot-entry-media} [Magento\MediaStorage\App\Media]({{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/MediaStorage/App/Media.php){:target="_blank"} retrieves media resources (that is, any files uploaded to media storage) from the database. It is used whenever the database is configured as a [media storage](https://glossary.magento.com/media-storage). @@ -107,6 +107,6 @@ When the request is redirected to the entry point, the Magento application parse This topic discussed the basics of Magento application initialization and bootstrapping. To find out how to set bootstrap environment variables, see one of the following topics: -* [Customize base directory paths (MAGE_DIRS)]({{ page.baseurl }}/config-guide/bootstrap/mage-dirs.html) -* [Set the mode (MAGE_MODE)]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html) -* [Enable an HTML profiler (MAGE_PROFILER)]({{ page.baseurl }}/config-guide/bootstrap/mage-profiler.html) +* [Customize base directory paths (MAGE_DIRS)]({{ page.baseurl }}/config-guide/bootstrap/mage-dirs.html) +* [Set the mode (MAGE_MODE)]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html) +* [Enable an HTML profiler (MAGE_PROFILER)]({{ page.baseurl }}/config-guide/bootstrap/mage-profiler.html) diff --git a/guides/v2.2/config-guide/bootstrap/magento-how-to-set.md b/guides/v2.2/config-guide/bootstrap/magento-how-to-set.md index 69cbf5ea046..271f845806b 100644 --- a/guides/v2.2/config-guide/bootstrap/magento-how-to-set.md +++ b/guides/v2.2/config-guide/bootstrap/magento-how-to-set.md @@ -32,13 +32,13 @@ You can specify Magento bootstrap variables as system-wide environment variables For example, you can use the `MAGE_PROFILER` system environment variable to specify a mode as follows: - MAGE_PROFILER={firebug|csv|} + MAGE_PROFILER={firebug|csv|} Set the variable using a shell-specific command. Because shells have differing syntax, consult a reference like [unix.stackexchange.com](http://unix.stackexchange.com/questions/117467/how-to-permanently-set-environmental-variables){:target="_blank"}. bash shell example for CentOS: - export MAGE_PROFILER=firebug + export MAGE_PROFILER=firebug {:.bs-callout .bs-callout-info} If a `PHP Fatal error` displays in the browser after you set a profiler value, restart your web server. The reason might be related to [PHP](https://glossary.magento.com/php) bytecode caching, which caches bytecodes and PHP classpaths. @@ -49,9 +49,9 @@ This section discusses how to specify the mode for either Apache or [nginx](http See one of the following sections for more information: -* [Specify a variable using an nginx setting](#mode-specify-web-nginx) -* [Specify a variable using .htaccess (Apache only)](#mode-specify-web-htaccess) -* [Specify a variable using an Apache setting](#mode-specify-web-apache) +* [Specify a variable using an nginx setting](#mode-specify-web-nginx) +* [Specify a variable using .htaccess (Apache only)](#mode-specify-web-htaccess) +* [Specify a variable using an Apache setting](#mode-specify-web-apache) ### Specify a variable using an nginx setting {#mode-specify-web-nginx} @@ -63,24 +63,24 @@ One way to set the Magento mode is by editing `.htaccess`. This way, you don't h You can modify `.htaccess` in any of the following locations, depending on your entry point to the Magento application: -* `/.htaccess` -* `/pub/.htaccess` +* `/.htaccess` +* `/pub/.htaccess` To set a variable: -1. Open any of the preceding files in a text editor and either add or uncomment the desired setting. +1. Open any of the preceding files in a text editor and either add or uncomment the desired setting. - For example, to specify a [mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html), uncomment the following: + For example, to specify a [mode]({{ page.baseurl }}/config-guide/bootstrap/magento-modes.html), uncomment the following: - # SetEnv MAGE_PROFILER firebug + # SetEnv MAGE_PROFILER firebug -2. Set the value of `MAGE_PROFILER` to any of the following: +2. Set the value of `MAGE_PROFILER` to any of the following: - firebug - csvfile - + firebug + csvfile + -2. Save your changes to `.htaccess`; you don't need to restart Apache for the change to take effect. +2. Save your changes to `.htaccess`; you don't need to restart Apache for the change to take effect. ### Specify a variable using an Apache setting {#mode-specify-web-apache} @@ -90,8 +90,8 @@ The Apache `mod_env` directive is slightly different in [version 2.2](http://htt The procedures that follows show how to set the Magento mode in an Apache virtual host. This is not the only way to use `mod_env` directives; consult the Apache documentation for details. -* [Specify a bootstrap variable for Apache on Ubuntu](#mode-specify-ubuntu) -* [Specify a bootstrap variable for Apache on CentOS](#mode-specify-centos) +* [Specify a bootstrap variable for Apache on Ubuntu](#mode-specify-ubuntu) +* [Specify a bootstrap variable for Apache on CentOS](#mode-specify-centos) #### Specify a bootstrap variable for Apache on Ubuntu {#mode-specify-ubuntu} @@ -99,34 +99,34 @@ This section assumes you've already set up your virtual host. If you have not, c To set a Magento bootstrap variable using your web server's environment: -1. As a user with `root` privileges, open your virtual host configuration file in a text editor. +1. As a user with `root` privileges, open your virtual host configuration file in a text editor. - For example, if your virtual host is named `my.magento`, + For example, if your virtual host is named `my.magento`, - * Apache 2.4: `vim /etc/apache2/sites-available/my.magento.conf` - * Apache 2.2: `vim /etc/apache2/sites-available/my.magento` + * Apache 2.4: `vim /etc/apache2/sites-available/my.magento.conf` + * Apache 2.2: `vim /etc/apache2/sites-available/my.magento` -2. Anywhere in the virtual host configuration, add the following line: +2. Anywhere in the virtual host configuration, add the following line: - SetEnv "" "" + SetEnv "" "" - For example, + For example, - SetEnv "MAGE_PROFILER" "firebug" + SetEnv "MAGE_PROFILER" "firebug" -3. Save your changes and exit the text editor. -4. Enable your virtual host if you haven't already done so: +3. Save your changes and exit the text editor. +4. Enable your virtual host if you haven't already done so: - a2ensite + a2ensite - For example, + For example, - a2ensite my.magento.conf + a2ensite my.magento.conf -5. Restart the web server: +5. Restart the web server: - * Ubuntu: `service apache2 restart` - * CentOS: `service httpd restart` + * Ubuntu: `service apache2 restart` + * CentOS: `service httpd restart` #### Specify a bootstrap variable for Apache on CentOS {#mode-specify-centos} @@ -134,25 +134,25 @@ This section assumes you've already set up your virtual host. If you have not, c To set a Magento bootstrap variable using your web server's environment: -1. As a user with `root` privileges, open `/etc/httpd/conf/httpd.conf` in a text editor. +1. As a user with `root` privileges, open `/etc/httpd/conf/httpd.conf` in a text editor. -2. Anywhere in the virtual host configuration, add the following line: +2. Anywhere in the virtual host configuration, add the following line: - SetEnv "" "" + SetEnv "" "" - For example, + For example, - SetEnv "MAGE_PROFILER" "firebug" + SetEnv "MAGE_PROFILER" "firebug" -3. Save your changes and exit the text editor. +3. Save your changes and exit the text editor. After setting the mode, restart the web server: -* Ubuntu: `service apache2 restart` -* CentOS: `service httpd restart` +* Ubuntu: `service apache2 restart` +* CentOS: `service httpd restart` #### Related topics -* [Customize base directory paths (MAGE_DIRS)]({{ page.baseurl }}/config-guide/bootstrap/mage-dirs.html) -* [Set the Magento mode]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-mode.html) -* [Enable an dependency graphs and built-in profiler (MAGE_PROFILER)]({{ page.baseurl }}/config-guide/bootstrap/mage-profiler.html) +* [Customize base directory paths (MAGE_DIRS)]({{ page.baseurl }}/config-guide/bootstrap/mage-dirs.html) +* [Set the Magento mode]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-mode.html) +* [Enable an dependency graphs and built-in profiler (MAGE_PROFILER)]({{ page.baseurl }}/config-guide/bootstrap/mage-profiler.html) diff --git a/guides/v2.2/config-guide/bootstrap/magento-modes.md b/guides/v2.2/config-guide/bootstrap/magento-modes.md index 88cb506e238..85f7852ff3f 100644 --- a/guides/v2.2/config-guide/bootstrap/magento-modes.md +++ b/guides/v2.2/config-guide/bootstrap/magento-modes.md @@ -10,49 +10,49 @@ functional_areas: You can run Magento in any of the following *modes*: - - - - - - - - - - - - + + + + + + + + + + + - - - - - + + + + + - - - + + +
    Mode nameDescription
    default

    Enables you to deploy the Magento application on a single server without changing any settings. However, default mode is not optimized for production.

    -

    To deploy the Magento application on more than one server or to optimize it for production, change to one of the other modes.

    -
    • Static view file caching is enabled
      • -
    • Exceptions are not displayed to the user; instead, exceptions are written to log files.
      • -
    • Hides custom X-Magento-* HTTP request and response headers
    -
    developer

    Intended for development only, this mode:

    -
    • Disables static view file caching
      • -
    • Provides verbose logging
      • -
    • Enables automatic code compilation
      • -
    • Enables enhanced debugging
      • -
    • Shows custom X-Magento-* HTTP request and response headers
      • -
    • Results in the slowest performance
      • -
    • Shows errors on the frontend
    +
    Mode nameDescription
    default

    Enables you to deploy the Magento application on a single server without changing any settings. However, default mode is not optimized for production.

    +

    To deploy the Magento application on more than one server or to optimize it for production, change to one of the other modes.

    +
    • Static view file caching is enabled
      • +
    • Exceptions are not displayed to the user; instead, exceptions are written to log files.
      • +
    • Hides custom X-Magento-* HTTP request and response headers
    +
    developer

    Intended for development only, this mode:

    +
    • Disables static view file caching
      • +
    • Provides verbose logging
      • +
    • Enables automatic code compilation
      • +
    • Enables enhanced debugging
      • +
    • Shows custom X-Magento-* HTTP request and response headers
      • +
    • Results in the slowest performance
      • +
    • Shows errors on the frontend
    production

    Intended for deployment on a production system, this mode:

    -
    • Does not show exceptions to the user (exceptions are written to logs only).
      • -
    • Serves static view files from cache only.
      • -
    • Prevents automatic code file compilation. New or updated files are not written to the file system.
      • -
    • Does not allow you to enable or disable cache types in Magento Admin. More information about enabling and disabling the cache.
      • -
    production

    Intended for deployment on a production system, this mode:

    +
    • Does not show exceptions to the user (exceptions are written to logs only).
      • +
    • Serves static view files from cache only.
      • +
    • Prevents automatic code file compilation. New or updated files are not written to the file system.
      • +
    • Does not allow you to enable or disable cache types in Magento Admin. More information about enabling and disabling the cache.
      • +
    maintenance

    Intended to prevent access to a Magento Commerce site while it is being updated or reconfigured, this mode:

    -
    • Redirects site visitors to a default Service Temporarily Unavailable page.
      • -
    • When the site is in maintenance mode, the var/ directory contains the .maintenance.flag file.
      • -
    • You can configure maintenance mode to allow visitor access from a specified list of IP addresses.
      • -
    maintenance

    Intended to prevent access to a Magento Commerce site while it is being updated or reconfigured, this mode:

    +
    • Redirects site visitors to a default Service Temporarily Unavailable page.
      • +
    • When the site is in maintenance mode, the var/ directory contains the .maintenance.flag file.
      • +
    • You can configure maintenance mode to allow visitor access from a specified list of IP addresses.
      • +
    @@ -99,7 +99,7 @@ In production mode: - Errors are logged to the file system and are never displayed to the user. - You can enable and disable cache types only using the [command line]({{ page.baseurl }}/config-guide/cli/config-cli-subcommands-cache.html#config-cli-subcommands-cache-en). - You _cannot_ enable or disable cache types using the Magento Admin + You _cannot_ enable or disable cache types using the Magento Admin ## Maintenance mode diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-cache.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-cache.md index 14bb790a07d..3f524467cba 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-cache.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-cache.md @@ -30,28 +30,28 @@ Magento 2 has the following [cache](https://glossary.magento.com/cache) types:

    Layout

    layout

    Compiled page layouts (that is, the layout components from all components).

    -

    Clean or flush this cache type after modifying layout files.

    +

    Clean or flush this cache type after modifying layout files.

    Block HTML output

    block_html

    HTML page fragments per block.

    -

    Clean or flush this cache type after modifying the view layer.

    +

    Clean or flush this cache type after modifying the view layer.

    Collections data

    collections

    Results of database queries.

    -

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    -

    Clean or flush this cache type if your custom module uses logic that results in cache entries that Magento cannot clean.

    +

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    +

    Clean or flush this cache type if your custom module uses logic that results in cache entries that Magento cannot clean.

    DDL

    db_ddl

    Database schema.

    -

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    -

    Clean or flush this cache type after you make custom changes to the database schema. (In other words, updates that Magento does not make itself.)

    -

    One way to update the database schema automatically is using the magento setup:db-schema:upgrade command.

    +

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    +

    Clean or flush this cache type after you make custom changes to the database schema. (In other words, updates that Magento does not make itself.)

    +

    One way to update the database schema automatically is using the magento setup:db-schema:upgrade command.

    Entity attribute value (EAV)

    @@ -63,8 +63,8 @@ Magento 2 has the following [cache](https://glossary.magento.com/cache) types:

    Page cache

    full_page

    Generated HTML pages.

    -

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    -

    Clean or flush this cache type after modifying code level that affects HTML output. It’s recommended to keep this cache enabled because caching HTML improves performance significantly.

    +

    If necessary, Magento cleans up this cache automatically, but third-party developers can put any data in any segment of the cache.

    +

    Clean or flush this cache type after modifying code level that affects HTML output. It’s recommended to keep this cache enabled because caching HTML improves performance significantly.

    Reflection

    @@ -80,7 +80,7 @@ Magento 2 has the following [cache](https://glossary.magento.com/cache) types:

    Integration configuration

    config_integration

    Compiled integrations.

    -

    Clean or flush this cache after changing or adding integrations.

    +

    Clean or flush this cache after changing or adding integrations.

    Integration API configuration

    @@ -154,7 +154,7 @@ bin/magento cache:disable db_ddl full_page Sample result: ```terminal - Changed cache status: + Changed cache status: db_ddl: 1 -> 0 full_page: 1 -> 0 ``` @@ -170,8 +170,8 @@ To purge out-of-date items from the cache, you can *clean* or *flush* cache type Disabled cache types are not cleaned. - {:.bs-callout .bs-callout-tip} - Always clean the cache after upgrading versions of {{site.data.var.ce}} or {{site.data.var.ee}}, upgrading from {{site.data.var.ce}} to {{site.data.var.ee}}, or installing {{site.data.var.b2b}} or any module. + {:.bs-callout .bs-callout-tip} + Always clean the cache after upgrading versions of {{site.data.var.ce}} or {{site.data.var.ee}}, upgrading from {{site.data.var.ce}} to {{site.data.var.ee}}, or installing {{site.data.var.b2b}} or any module. - Flushing a cache type purges the cache storage, which might affect other processes applications that are using the same storage. @@ -193,18 +193,18 @@ bin/magento cache:flush Sample result: ```terminal - Flushed cache types: - config - layout - block_html - collections - db_ddl - eav - full_page - translate - config_integration - config_integration_api - config_webservice + Flushed cache types: + config + layout + block_html + collections + db_ddl + eav + full_page + translate + config_integration + config_integration_api + config_webservice ``` {:.bs-callout .bs-callout-info} diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-depen.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-depen.md index 1d30992544b..1fb31252a94 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-depen.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-depen.md @@ -23,7 +23,7 @@ A dependency in a comment is also a dependency. Command options: - bin/magento info:dependencies:{show-modules|show-modules-circular|show-framework} [-d|--directory=""] [-o|--output="magento/module-store->magento/module-directory->magento/module-config" - "magento/module-config->magento/module-store->magento/module-config" - "magento/module-config->magento/module-cron->magento/module-config" - "magento/module-config->magento/module-email->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-theme->magento/module-customer->magento/module-eav->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-reports->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-catalog->magento/module-theme->magento/module-eav->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-catalog->magento/module-log->magento/module-eav->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-checkout->magento/module-catalog-inventory->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-checkout->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-theme->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-payment->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-checkout->magento/module-customer->magento/module-review->magento/module-catalog->magento/module-themeax->magento/module-config" - "magento/module-config->magento/module-backend->magento/module-sales->magento/module-checkout->magento/module-customer->magento/module-review->magento/module-catalog->magento/module-catalog-rule->magento/module-rule->magento/module-eav->magento/module-config" + "Circular dependencies:","Total number of chains" + "","848" + + "Circular dependencies for each module:","" + "magento/module-config","70" + "magento/module-config->magento/module-store->magento/module-directory->magento/module-config" + "magento/module-config->magento/module-store->magento/module-config" + "magento/module-config->magento/module-cron->magento/module-config" + "magento/module-config->magento/module-email->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-theme->magento/module-customer->magento/module-eav->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-reports->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-catalog->magento/module-theme->magento/module-eav->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-catalog->magento/module-log->magento/module-eav->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-checkout->magento/module-catalog-inventory->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-checkout->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-customer->magento/module-theme->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-payment->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-checkout->magento/module-customer->magento/module-review->magento/module-catalog->magento/module-themeax->magento/module-config" + "magento/module-config->magento/module-backend->magento/module-sales->magento/module-checkout->magento/module-customer->magento/module-review->magento/module-catalog->magento/module-catalog-rule->magento/module-rule->magento/module-eav->magento/module-config" ### Sample framework dependencies report The following is a portion of the output for a sample framework dependencies report: - "Dependencies of framework:","Total number" - "","111" + "Dependencies of framework:","Total number" + "","111" - "Dependencies for each module:","" - "Magento\Cron","1" - " -- Magento\Framework","143" + "Dependencies for each module:","" + "Magento\Cron","1" + " -- Magento\Framework","143" - "Magento\CatalogRule","1" - " -- Magento\Framework","234" + "Magento\CatalogRule","1" + " -- Magento\Framework","234" - "Magento\Webapi","2" - " -- Magento\Framework","347" - " -- Magento\Server","1" + "Magento\Webapi","2" + " -- Magento\Framework","347" + " -- Magento\Server","1" - "Magento\Checkout","1" - " -- Magento\Framework","759" + "Magento\Checkout","1" + " -- Magento\Framework","759" - "Magento\Reports","1" - " -- Magento\Framework","553" + "Magento\Reports","1" + " -- Magento\Framework","553" diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-layout-xml.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-layout-xml.md index 3bd3982e294..3d975d5847a 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-layout-xml.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-layout-xml.md @@ -22,7 +22,7 @@ For more information about layout XML files, see: Command options: - bin/magento dev:xml:convert [-o|--overwrite] {xml file} {xslt stylesheet} + bin/magento dev:xml:convert [-o|--overwrite] {xml file} {xslt stylesheet} here: diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-less-sass.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-less-sass.md index cbdfd958a4c..a89c8844569 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-less-sass.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-less-sass.md @@ -22,43 +22,43 @@ bin/magento dev:source-theme:deploy [--type="..."] [--locale="..."] [--area="... The following table explains this command's parameters and values. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ParameterValueRequired?

    --type

    Type of source files: [less] (default: "less")

    -

    Currently, LESS is the only file type supported.

    No

    --locale

    Locale code.

    -

    To display the list of locale codes, enter bin/magento info:language:list

    No

    --area

    Area (adminhtml for the administrative area, frontend for the storefront).

    No

    --theme

    Theme name in <VendorName>/<theme name> format. For example, Magento/blank or Magento/backend.

    No

    <file>

    Space-separated list of CSS files to convert to LESS without the .css extension. (Default is css/styles-m css/styles-l, for adminhtml type css/styles css/styles-old)

    No
    ParameterValueRequired?

    --type

    Type of source files: [less] (default: "less")

    +

    Currently, LESS is the only file type supported.

    No

    --locale

    Locale code.

    +

    To display the list of locale codes, enter bin/magento info:language:list

    No

    --area

    Area (adminhtml for the administrative area, frontend for the storefront).

    No

    --theme

    Theme name in <VendorName>/<theme name> format. For example, Magento/blank or Magento/backend.

    No

    <file>

    Space-separated list of CSS files to convert to LESS without the .css extension. (Default is css/styles-m css/styles-l, for adminhtml type css/styles css/styles-old)

    No
    For example, to create LESS files for the frontend theme named `VendorName/themeName` in the `en_US` locale using a CSS file named `/pub/static/frontend/VendorName/themeName/en_US/css/styles-l.css`, enter the following command: diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md index a626901b8e8..e13928c0032 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-mode.md @@ -24,11 +24,11 @@ Refer to [Magento ownership and permissions in development and production]({{ pa When you change to developer or production mode, we clear the contents of following directories: - var/cache - generated/metadata - generated/code - var/view_preprocessed - pub/static + var/cache + generated/metadata + generated/code + var/view_preprocessed + pub/static Exceptions: @@ -82,29 +82,29 @@ bin/magento deploy:mode:set production Messages similar to the following display: - Enabled maintenance mode - Requested languages: en_US - === frontend -> Magento/luma -> en_US === - ... more ... - Successful: 1884 files; errors: 0 - --- - - === frontend -> Magento/blank -> en_US === - ... more ... - Successful: 1828 files; errors: 0 - --- - - === adminhtml -> Magento/backend -> en_US === - ... more ... - --- - - === Minify templates === - ... more ... - Successful: 897 files modified - --- - - New version of deployed files: 1440461332 - Static content deployment complete + Enabled maintenance mode + Requested languages: en_US + === frontend -> Magento/luma -> en_US === + ... more ... + Successful: 1884 files; errors: 0 + --- + + === frontend -> Magento/blank -> en_US === + ... more ... + Successful: 1828 files; errors: 0 + --- + + === adminhtml -> Magento/backend -> en_US === + ... more ... + --- + + === Minify templates === + ... more ... + Successful: 897 files modified + --- + + New version of deployed files: 1440461332 + Static content deployment complete Gathering css/styles-m.less sources. Successfully processed LESS and/or [Sass](https://glossary.magento.com/sass) files [CSS](https://glossary.magento.com/css) deployment complete @@ -115,9 +115,9 @@ Generated classes: Magento\Sales\Api\Data\CreditmemoComment\Repository Magento\Sales\Api\Data\CreditmemoItemInterfacePersistor ... more ... - Compilation complete - Disabled maintenance mode - Enabled production mode. + Compilation complete + Disabled maintenance mode + Enabled production mode. ### Change to developer mode @@ -137,7 +137,7 @@ When you change from production to developer mode, you should clear generated cl The following message displays: - Enabled developer mode. + Enabled developer mode. ### Change to default mode diff --git a/guides/v2.2/config-guide/cli/config-cli-subcommands-perf-data.md b/guides/v2.2/config-guide/cli/config-cli-subcommands-perf-data.md index 18c210c79f7..f67a6b82725 100644 --- a/guides/v2.2/config-guide/cli/config-cli-subcommands-perf-data.md +++ b/guides/v2.2/config-guide/cli/config-cli-subcommands-perf-data.md @@ -30,15 +30,15 @@ Profiles are located in `/setup/performance-toolkit/profiles/ - - - Parameter - Small profile - Medium profile - Medium multi-site profile - Large profile - Extra large profile - + + + Parameter + Small profile + Medium profile + Medium multi-site profile + Large profile + Extra large profile +

    websites

    @@ -160,7 +160,7 @@ For example, `/var/www/html/magento2/setup/performance-toolkit/profiles/ce`

    100,000

    150,000

    - + ### Run the data generator {#config-cli-perf-run} @@ -172,17 +172,17 @@ Run the command as discussed in this section. After the command runs, you must [ Command options: - bin/magento setup:perf:generate-fixtures {path to profile} + bin/magento setup:perf:generate-fixtures {path to profile} Where `` specifies the absolute file system path to, and name of, a profile. For example, - bin/magento setup:perf:generate-fixtures /var/www/html/magento2/setup/performance-toolkit/profiles/ce/small.xml + bin/magento setup:perf:generate-fixtures /var/www/html/magento2/setup/performance-toolkit/profiles/ce/small.xml Sample output for the small profile: - Generating profile with following params: + Generating profile with following params: |- Websites: 1 |- Store Groups Count: 1 |- Store Views Count: 1 @@ -205,7 +205,7 @@ Sample output for the small profile: Generating categories... done in