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

Update Docker command help #8197

Merged
merged 2 commits into from
Nov 6, 2020
Merged

Update Docker command help #8197

merged 2 commits into from
Nov 6, 2020

Conversation

meker12
Copy link
Contributor

@meker12 meker12 commented Nov 6, 2020

  • Addedd new options to the magento-docker CLI
  • Added listing that shows all available options for ece-docker
    build:compose command
  • Added intro to Docker Compose section

Purpose of this pull request

Updated Magento Cloud Docker Quick Reference topic:

  • Added intro to Docker Compose section
  • Added listing that shows all available options for ece-docker
    build:compose command
  • Added new options to the magento-docker CLI

Affected DevDocs pages

Updated Docker Quick reference
d856920 
- Addedd new options to the magento-docker CLI
- Added listing that shows all available options for ece-docker
build:compose command
- Added intro to Docker Compose section
@meker12 meker12 self-assigned this Nov 6, 2020
@meker12 meker12 requested a review from hguthrie November 6, 2020 19:10
@meker12 meker12 added Internal Dev Differentiates work between community and Magento staff 2.x labels Nov 6, 2020
@meker12 meker12 requested a review from bdenham November 6, 2020 19:10
@meker12 meker12 merged commit dbc2cb3 into Cloud-Docker-1.2.0 Nov 6, 2020
@ghost
Copy link

ghost commented Nov 6, 2020

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.

@meker12 meker12 deleted the mae-update-docker-command-help branch November 6, 2020 20:55
hguthrie
hguthrie reviewed Nov 6, 2020
View reviewed changes
Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

Looks like you merged before I could finish reviewing, so just pushing this for posterity.

src/cloud/docker/docker-quick-reference.md
@@ -10,6 +10,8 @@ functional_areas:

## Docker Compose

Docker Compose is a tool for defining and running multi-container Docker applications. The following table lists the Docker Compose commands for building, deploying, and operating {{site.data.var.mcd-prod}}. You can also use [Magento Cloud Docker CLI](#magento-cloud-docker-cli) commands to complete Docker Compose tasks.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Docker Compose is a tool for defining and running multi-container Docker applications. The following table lists the Docker Compose commands for building, deploying, and operating {{site.data.var.mcd-prod}}. You can also use [Magento Cloud Docker CLI](#magento-cloud-docker-cli) commands to complete Docker Compose tasks.
Docker Compose is a tool for defining and running multi-container Docker applications. The following table lists the `docker-compose` commands for building, deploying, and operating {{site.data.var.mcd-prod}}. You can use [Magento Cloud Docker CLI](#magento-cloud-docker-cli) commands to complete Docker Compose tasks.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, this is a reference or cheatsheet. The original intent was something quick without much dialog. The link may not be necessary.

src/cloud/docker/docker-quick-reference.md
php ./vendor/bin/ece-docker build:compose -h
```

```terminal
Copy link
Contributor

Choose a reason for hiding this comment

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

I would not display the output from a help command here for a couple of reasons. First, it's a quick reference or a cheat sheet. Just a place to remind people about certain commands. Second, a help list of this size might be a maintenance.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My plan is to automate the output for all of the CLI commands. I put this here because the service-versions table is hard to maintain, and there are many options that are not included there.

meker12 added a commit that referenced this pull request Nov 9, 2020
@meker12 @oshmyheliuk
@jeff-matthews @BaDos @hguthrie
Cloud Docker 1.2.0 Release (#8199)
6bcb986 
* MCLOUD-6430: Xdebug not working on Magento Cloud Docker 1.1 (#7810)

* MCLOUD-6430: Xdebug not working on Magento Cloud Docker 1.1

* Update src/cloud/docker/docker-development-debug.md
* MCLOUD-6898: Add option to customize port for MailHog (#7860)
* MCLOUD-6898: Add option to customize port for MailHog
* MCLOUD-6660: Add option to disable MailHog
* Update src/cloud/docker/docker-config.md
* MCLOUD-2789: [Cloud Docker] Add custom ES plugins (#7898)
* MCLOUD-2789: [Cloud Docker] Add support for adding custom ES plugins from services.yaml file to the docker-compose.yml file.
* MCLOUD-6394: Help with running MFTF test generation commands (#7995)
* MCLOUD-6394: Help with running MFTF test generation commands
* Added `--with-test` option to `build:compose` option list
* Update src/cloud/docker/docker-containers.md
  - Added test container
* Update src/cloud/docker/docker-containers-service.md
   Added `--with-test` option to `build:compose` option list
* Update Docker command help (#8197)
* Updated Docker Quick reference
- Addedd new options to the magento-docker CLI
- Added listing that shows all available options for ece-docker
build:compose command
- Added intro to Docker Compose section
* Updates for Cloud Docker 1.2.0 release (#8198)
* MCLOUD-7809 Added instructions for building custom docker-compose.yaml file
* Improved instructions for using the init-docker.sh installation script
* Updates based on review feedback
* Updated Launch developer mode instructions to add step
to apply patches before deploying to a Magento Cloud
Docker environment

Co-authored-by: Oleksandr Shmyheliuk <[email protected]>
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: Jeff Matthews <[email protected]>
Co-authored-by: Bohdan Korablov <[email protected]>
Co-authored-by: hguthrie <[email protected]>
meker12 added a commit that referenced this pull request Nov 9, 2020
@bdenham @oshmyheliuk
@andriyShevtsov @meker12 @arhiopterecs @hguthrie @jeff-matthews @BaDos
Cloud packages november release (#8203)
32e9d27 
* ECE-Tools 2002.1.3 docs and release notes (#8161)

* MCLOUD-6939: Errors occur running magento commands in composer cloud docker installation (#8007)

* Added variable to skip composer dump-autoload command processing when deploying a Magento Cloud project to a Cloud Docker environment.

* MCLOUD-7072: Add CLI command for generating .magento.env.yaml (#8040)

* MCLOUD-7072: Add CLI commands for creating and updating .magento.env.yaml
* Apply suggestions from code review
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>

* MCLOUD-6805: ECE-Tools release notes

WIP: updating variables

* MCLOUD-6805: ECE-Tools release notes

First draft

* MCLOUD-6805: ECE-Tools release notes

Fixed double slash on link

* added links to two  hot fixes

* Update services-mysql.md (#8051 
* Update Magento Cloud Docker instructions for adding custom PHP extensions (#8145)

* [Doc] Adding new PHP extensions #155 (#7929)

* Clean up instructions for adding PHP extensions
- Move extension configuration attribute descriptions and examples
to a separate section
* Fixed markdown syntax
* Fix link definitions
* Fix link syntax

* Apply suggestions from code review

Co-authored-by: Yevhen Miroshnychenko <[email protected]>
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: hguthrie <[email protected]>

* MCLOUD-6805: ECE-Tools release notes

Updated entry for MCLOUD-7098

* MCLOUD-6805: ECE-Tools release notes

Fixed merge conflicts

* Added docs for SKIP_COMPOSER_DUMP_AUTOLOAD

* Apply suggestions from code review

Co-authored-by: Margaret Eker <[email protected]>

* MCLOUD-6805: ECE-Tools release notes

Added release notes entry for #7191

* Update error-codes information with current info (#8152)

* Update error-codes information with current info

- Replaced file with error-code.md file generated from the ece-tools package

* Fixed error messages

* Add source file for generating the error code ref

Co-authored-by: Barny Shergold <[email protected]>

* Fixed comment syntax on internal note

* MCLOUD-6805: ECE-Tools release notes

Added release not for MCLOUD-7193

* MCLOUD-6805: ECE-Tools release notes

Fixed silly empty bullet

* MCLOUD-6805: ECE-Tools release notes

Per review, updated additional ece-tools docs changes that are unassociated with the release notes.

* MCLOUD-6805: ECE-Tools release notes

Per review, removed extra space from yaml code block.

* MCLOUD-6805: ECE-Tools release notes

Per review, tweaking the wording for writeable Cloud Docker environments.

* MCLOUD-6805: ECE-Tools release notes

Per review, forgot to clarify the pronoun that.

* MCLOUD-6805: ECE-Tools release notes

Per review, removed extra space, missed it first time around.

* MCLOUD-6805: ECE-Tools release notes

Ordered 'new' release note before fixed

* MCLOUD-6805: ECE-Tools release notes

Added links to documentation.

* MCLOUD-6805: ECE-Tools release notes

Added links to documentation.
* Apply suggestions from code review

* Cloud Docker 1.2.0 Release (#8199)

* MCLOUD-6430: Xdebug not working on Magento Cloud Docker 1.1 (#7810)
* Update src/cloud/docker/docker-development-debug.md
* MCLOUD-6898: Add option to customize port for MailHog (#7860)
* MCLOUD-6898: Add option to customize port for MailHog
* MCLOUD-6660: Add option to disable MailHog
* Update src/cloud/docker/docker-config.md
* MCLOUD-2789: [Cloud Docker] Add custom ES plugins (#7898)
* MCLOUD-2789: [Cloud Docker] Add support for adding custom ES plugins from services.yaml file to the docker-compose.yml file.
* MCLOUD-6394: Help with running MFTF test generation commands (#7995)
* MCLOUD-6394: Help with running MFTF test generation commands
* Added `--with-test` option to `build:compose` option list
* Update src/cloud/docker/docker-containers.md
  - Added test container
* Update src/cloud/docker/docker-containers-service.md
   Added `--with-test` option to `build:compose` option list
* Update Docker command help (#8197)
* Updated Docker Quick reference
- Addedd new options to the magento-docker CLI
- Added listing that shows all available options for ece-docker
build:compose command
- Added intro to Docker Compose section
* Updates for Cloud Docker 1.2.0 release (#8198)
* MCLOUD-7809 Added instructions for building custom docker-compose.yaml file
* Improved instructions for using the init-docker.sh installation script
* Updates based on review feedback
* Updated Launch developer mode instructions to add step
to apply patches before deploying to a Magento Cloud
Docker environment

Co-authored-by: Oleksandr Shmyheliuk <[email protected]>
Co-authored-by: Andrii Shevtsov <[email protected]>
Co-authored-by: Margaret Eker <[email protected]>
Co-authored-by: Yevhen Miroshnychenko <[email protected]>
Co-authored-by: Barny Shergold <[email protected]>
Co-authored-by: hguthrie <[email protected]>
Co-authored-by: Jeff Matthews <[email protected]>
Co-authored-by: Bohdan Korablov <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@hguthrie hguthrie hguthrie left review comments

@bdenham bdenham Awaiting requested review from bdenham

Assignees

@hguthrie hguthrie

@meker12 meker12

Labels
2.x Internal Dev Differentiates work between community and Magento staff
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@meker12 @hguthrie