Cloud packages August release #7669

meker12 · 2020-08-04T18:19:28Z

Purpose of this pull request

Documentation updates for the Cloud packages August 2020 release

Affected DevDocs pages

whatsnew
Published release notes and documentation updates for the June 2020 Magento Cloud packages release:

* MCLOUD-6485: Add validator for braintree variable existence * Update src/cloud/project/project-conf-files_magento-app.md * Apply suggestions from code review Co-authored-by: Margaret Eker <meker@adobe.com>

* MCLOUD-6137: Mention error log file * MCLOUD-6221: Add specific error code in some steps * MCLOUD-6221: Add specific error code in some steps

* Error message updates: - Removed error suggestions data file which is replaced by error-codes.md file in the _includes directory - Added include file with error code tables generated from ece-tools source code - Renamed error-codes.md to ece-tools-error-reference.md and updated toc/cloud-guide.yml - Replaced embedded error code tables with _includes/cloud/error-codes.md - Added sample of cloud.errors.log entry (JSON string), updated log field descriptions to match the ones in the cloud.errors.log * Add renamed error message reference topic * Clarify that only cloud.error.log is in JSON format * Adding updated error code tables generated from ece-tools * MCLOUD-6530: Fix an issue with empty error code in the StepException (#7581) - Updated error-codes.md * Remove obsolete file * MCLOUD-6530: Fix an issue with empty error code in the StepException (#7582) * MCLOUD-6530: Fix an issue with empty error code in the StepException - Updated error-codes.md * MCLOUD-6530: Fix an issue with empty error code in the StepException - Updated error-codes.md * MCLOUD-6530: Fix an issue with empty error code in the StepException - Updated error-codes.md * Update src/_includes/cloud/error-codes.md Co-authored-by: hguthrie <hguthrie@users.noreply.github.com> * Update src/cloud/project/log-locations.md Co-authored-by: hguthrie <hguthrie@users.noreply.github.com> * Update src/cloud/reference/ece-tools-error-reference.md Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com> Co-authored-by: Oleksandr Shmyheliuk <oshmyheliuk@magento.com> Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* Added release notes * Added JIRA ticket number

Updated release date variable to TBD

…nto Cloud-packages-release

* MCLOUD-5624: Unable to enable sending email in the docker * Update src/cloud/docker/docker-config.md Co-authored-by: Margaret Eker <meker@adobe.com> * Update src/cloud/docker/docker-config.md Co-authored-by: Margaret Eker <meker@adobe.com> * Added line break * Added release note for HogMail service support on Cloud Docker * Editorial update Co-authored-by: Margaret Eker <meker@adobe.com>

to apply them - Added Patches release notes for MCLOUD-6139, MCLOUD-6110, MCLOUD-6588 - Added ece-tools release notes for MCLOUD-5878, MCLOUD-5879, MCLOUD-6221 MCLOUD-6375 - Added QUALITY_PATCHES variable to build variables with note about internal-only user

hguthrie · 2020-08-04T19:24:56Z

The link you provide to the error reference is : https://devdocs.magento.com/cloud/reference/ece-tools-error-reference.html
But that says page not #found.
Is it https://devdocs.magento.com/cloud/reference/error-codes.html ?

Also, you have some mismatched titling with this topic that really needs some clarification and normalizing. The Navigation says Error log message reference and the topic title says Error message reference for ece-tools and the file name is error-codes and soon to be ece-tools-error-reference.

meker12 · 2020-08-04T21:28:23Z

The link you provide to the error reference is : https://devdocs.magento.com/cloud/reference/ece-tools-error-reference.html
But that says page not #found.
Is it https://devdocs.magento.com/cloud/reference/error-codes.html ?

Also, you have some mismatched titling with this topic that really needs some clarification and normalizing. The Navigation says Error log message reference and the topic title says Error message reference for ece-tools and the file name is error-codes and soon to be ece-tools-error-reference.

The file name for the error message reference changes, so the new file is https://devdocs.magento.com/cloud/reference/ece-tools-error-reference.html. Not yet available on DevDocs because the topic hasn't been published yet.

Updated the topic title to "Error message reference for ece-tools.

- MCLOUD-5624 - MCLOUD-6621 - MCLOUD-6424 Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

src/cloud/release-notes/ece-release-notes.md

shiftedreality · 2020-08-05T16:53:19Z

src/cloud/docker/docker-development-debug.md

@@ -23,7 +23,7 @@ If you use Microsoft Windows, take the following steps before continuing:
 1. To enable Xdebug for your Docker environment, generate the Docker Compose configuration file in developer mode with the `--with-xdebug` option and any other required options, for example.

   ```bash
-   vendor/bin/ece-docker build:compose --mode --sync-engine="mutagen" developer --with-xdebug
+   vendor/bin/ece-docker build:compose --mode developer --sync-engine="mutagen" --with-xdebug


I would suggest having same format for all options:

--mode="developer" --sync-engine="mutagen" --with-xdebug

src/cloud/docker/docker-development-debug.md

src/cloud/docker/docker-config.md

hguthrie

I'll end this, I can't finish just yet.

hguthrie · 2020-08-05T15:32:40Z

src/cloud/docker/docker-config.md

-
-{:.bs-callout-warning}
-We do not recommend using Sendmail on CLI containers because the service can slow down the container creation process.
+When the MailHog service is installed, go to the following URL to open the service and view outgoing emails: `http://magento2.docker:8025`


It would easier for readers to copy this URL if it were in a code block.

src/cloud/project/project-conf-files_magento-app.md

dobooth · 2020-08-05T21:03:56Z

src/cloud/project/project-upgrade.md

@@ -47,7 +47,7 @@ After upgrading, you can remove the `config.php` file and generate a new, comple

 ### Update the configuration file

-If you are upgrading from an older version of Magento to 2.2.x or later, you must also update your [.magento.app.yaml] file or you might encounter errors. {{site.data.var.ece}} 2.2.x and later has new settings in the file.
+When you upgrade, you might need to update your [.magento.app.yaml] file to account for changes in the default configuration settings that are sometimes introduced to support changes in {{site.data.var.ece}} or the Magento application.


Why brackets around the .magento.app.yml?

It's a link.

dobooth · 2020-08-05T21:04:59Z

src/cloud/reference/ece-tools-error-reference.md

+  - /cloud/reference/error-codes.html
+---
+
+This error message reference provides information to troubleshoot errors that can occur during the {{site.data.var.ece }} buid, deploy, and post-deploy processes.


"provides information on..." "build"

dobooth · 2020-08-05T21:07:15Z

src/cloud/release-notes/ece-release-notes.md

+-  {:.new}Added the **QUALITY_PATCHES** environment variable to specify one or more patches to apply during the deployment process. Currently, this variable is for Magento internal use only.<!--MCLOUD-6375-->
+
+## v2002.1.1
+*Release date: June 25, 2020*<br/>


Looks like they aren't used after headers in release notes.

dobooth · 2020-08-05T21:09:42Z

src/cloud/release-notes/mcd-release-notes.md

+<style>
+table.docker-service-versions-table td:nth-child(2) {
+  width: 500px;
+}


Do you need to close the style tag?

src/cloud/reference/ece-tools-error-reference.md

src/cloud/release-notes/mcd-release-notes.md

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

meker12 · 2020-08-05T21:23:32Z

running tests

ghost · 2020-08-05T22:05:03Z

Hi @meker12, 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.

oshmyheliuk and others added 16 commits July 22, 2020 14:34

MCLOUD-6485: Add validator for braintree variable existence (#7571)

e99edc8

* MCLOUD-6485: Add validator for braintree variable existence * Update src/cloud/project/project-conf-files_magento-app.md * Apply suggestions from code review Co-authored-by: Margaret Eker <meker@adobe.com>

Remove version info from app.yaml update section

1bd5ad8

Remove trailing spaces

397f11e

MCLOUD-6221: Add specific error code in some steps (#7573)

5096b4c

* MCLOUD-6137: Mention error log file * MCLOUD-6221: Add specific error code in some steps * MCLOUD-6221: Add specific error code in some steps

Merge branch 'master' into Cloud-packages-release

8ab7615

Add new sections for upcoming package releases

9ca2a83

Fixed Docker release version

540df6a

Added Magento Cloud Components 1.0.6 release notes (#7599)

7b9b00e

* Added release notes * Added JIRA ticket number

Fixed Docker release version

33524fe

Updated release date variable to TBD

Merge branch 'Cloud-packages-release' of github.com:magento/devdocs i…

0c5f915

…nto Cloud-packages-release

Merge branch 'master' into Cloud-packages-release

1b7321e

Merge branch 'master' into Cloud-packages-release

fb91bc5

Merge branch 'master' into Cloud-packages-release

a7124d8

meker12 self-assigned this Aug 4, 2020

m2-community-project bot added the Progress: review label Aug 4, 2020

meker12 added Internal Dev Differentiates work between community and Magento staff 2.x Major Update Significant original updates to existing content labels Aug 4, 2020

meker12 changed the title ~~Cloud packages release~~ Cloud packages August release Aug 4, 2020

srsathish92 mentioned this pull request Aug 4, 2020

MCLOUD-6698: Update deploy ES version config validator magento/ece-tools#769

Merged

5 tasks

maeker12 and others added 2 commits August 4, 2020 14:51

Updates based on review feedback

1cac710

Console command quick fix (#7670)

b9cc746

Added Docker 1.1.1 release notes (#7674)

dcb38c1

- MCLOUD-5624 - MCLOUD-6621 - MCLOUD-6424 Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>

meker12 requested review from hguthrie and YPyltiai August 4, 2020 22:24

maeker12 added 3 commits August 4, 2020 18:35

Fixed release note for database mount configuration options

ae8774f

Fixed broken links

868d597

Merge branch 'master' into Cloud-packages-release

8aec9a0

meker12 commented Aug 5, 2020

View reviewed changes

src/cloud/release-notes/ece-release-notes.md Outdated Show resolved Hide resolved

shiftedreality approved these changes Aug 5, 2020

View reviewed changes

m2-community-project bot assigned shiftedreality Aug 5, 2020

m2-community-project bot added Progress: approved and removed Progress: review labels Aug 5, 2020

meker12 commented Aug 5, 2020

View reviewed changes

src/cloud/docker/docker-development-debug.md Outdated Show resolved Hide resolved

Apply suggestions from code review

42c42b4

meker12 commented Aug 5, 2020

View reviewed changes

src/cloud/docker/docker-config.md Outdated Show resolved Hide resolved

meker12 requested a review from dobooth August 5, 2020 21:02

hguthrie reviewed Aug 5, 2020

View reviewed changes

m2-community-project bot assigned hguthrie Aug 5, 2020

m2-community-project bot added Progress: review and removed Progress: approved labels Aug 5, 2020

dobooth approved these changes Aug 5, 2020

View reviewed changes

m2-community-project bot assigned dobooth Aug 5, 2020

m2-community-project bot added Progress: approved and removed Progress: review labels Aug 5, 2020

meker12 commented Aug 5, 2020

View reviewed changes

src/cloud/reference/ece-tools-error-reference.md Outdated Show resolved Hide resolved

meker12 commented Aug 5, 2020

View reviewed changes

src/cloud/release-notes/mcd-release-notes.md Outdated Show resolved Hide resolved

meker12 and others added 3 commits August 5, 2020 16:21

Apply suggestions from code review

401db1c

Apply suggestions from code review

a54d8dd

Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

Merge branch 'master' into Cloud-packages-release

82db75f

meker12 merged commit 120795f into master Aug 5, 2020

m2-community-project bot removed the Progress: approved label Aug 5, 2020

meker12 deleted the Cloud-packages-release branch August 17, 2020 20:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cloud packages August release #7669

Cloud packages August release #7669

meker12 commented Aug 4, 2020 •

edited

Loading

hguthrie commented Aug 4, 2020 •

edited by meker12

Loading

meker12 commented Aug 4, 2020

shiftedreality Aug 5, 2020

hguthrie left a comment

hguthrie Aug 5, 2020

dobooth Aug 5, 2020

meker12 Aug 5, 2020

dobooth Aug 5, 2020

dobooth Aug 5, 2020

dobooth Aug 5, 2020

dobooth Aug 5, 2020

meker12 commented Aug 5, 2020

ghost commented Aug 5, 2020

Cloud packages August release #7669

Cloud packages August release #7669

Conversation

meker12 commented Aug 4, 2020 • edited Loading

Purpose of this pull request

Affected DevDocs pages

hguthrie commented Aug 4, 2020 • edited by meker12 Loading

meker12 commented Aug 4, 2020

Choose a reason for hiding this comment

hguthrie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

meker12 commented Aug 5, 2020

ghost commented Aug 5, 2020

meker12 commented Aug 4, 2020 •

edited

Loading

hguthrie commented Aug 4, 2020 •

edited by meker12

Loading