Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Conversation

hguthrie
Copy link
Contributor

Completed a task to update the Project structure topic to include information on changing the base template.

  • added steps to change base template
  • changed the section locations and headings to follow a logical flow
  • updated the log file locations
  • updated the example output
  • clarified the section on ignoring files
  • formatted the markdown table purely for readability (no affect on content)

whatsnew
Added section to Cloud Project structure about how to change the base template.

@hguthrie hguthrie added 2.2.x Internal Dev Differentiates work between community and Magento staff 2.3.x Magento 2.3 related changes Technical Updates to the code or processes that alter the technical content of the doc labels Jan 15, 2019
@hguthrie hguthrie self-assigned this Jan 15, 2019
Copy link
Contributor

@meker12 meker12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few editorial suggestions

`.gitignore` | Specify which files and directories to ignore. See [`.gitignore` reference](#ignoring-files).
`.magento.app.yaml` | Configuration file that defines the properties to build your application. See [Configure environments]({{ page.baseurl }}/cloud/env/environments.html).
`.magento.env.yaml` | Configuration file that defines actions for the build, deploy, and post-deploy phases. The ece-tools package includes a sample of this file with detailed descriptions for the available variables. See [Configure environments]({{ page.baseurl }}/cloud/env/environments.html).
`composer.json` | Fetches the Magento Enterprise Edition and the necessary configuration scripts to prepare your application. See [Prepare your Magento install]({{ page.baseurl }}/cloud/setup/first-time-setup-import-prepare.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The title on the link text sounds odd: Prepare your existing Magento Commerce install -- the TOC title for this linked topic makes more sense: Prepare your existing Magento Commerce system (See https://devdocs.magento.com/guides/v2.3/cloud/setup/first-time-setup-import-prepare.html)

`.magento.env.yaml` | Configuration file that defines actions for the build, deploy, and post-deploy phases. The ece-tools package includes a sample of this file with detailed descriptions for the available variables. See [Configure environments]({{ page.baseurl }}/cloud/env/environments.html).
`composer.json` | Fetches the Magento Enterprise Edition and the necessary configuration scripts to prepare your application. See [Prepare your Magento install]({{ page.baseurl }}/cloud/setup/first-time-setup-import-prepare.html).
`composer.lock` | Stores version dependencies for every package.
`magento-vars.php` | A file used to define [multiple stores]({{ page.baseurl }}/cloud/project/project-multi-sites.html#modify-the-magento-varsphp-file) and sites using [Magento variables]({{ page.baseurl }}/config-guide/multi-site/ms_over.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These link targets seem confusing ---

multiple stores ==> Modify the magento-vars.php file topic in Cloud docs
Magento variables ==> Multiple websites or stores overview topic in Configuration Guide

Please check

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine for the table. The Config guide link talks about the Admin UI and defining the Magento variables: Use the MAGE_RUN_TYPE and MAGE_RUN_CODE variables
The Cloud link explains the implementation for Cloud and you can see those variables in use.

@hguthrie
Copy link
Contributor Author

runnings tests

@hguthrie
Copy link
Contributor Author

running tests

@hguthrie hguthrie merged commit 6dea52e into master Jan 16, 2019
@ghost
Copy link

ghost commented Jan 16, 2019

Hi @hguthrie, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@hguthrie hguthrie deleted the hg-mc1581-template branch January 17, 2019 23:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.2.x 2.3.x Magento 2.3 related changes Internal Dev Differentiates work between community and Magento staff Technical Updates to the code or processes that alter the technical content of the doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants