Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Adding new PHP extensions #155 #7929

Conversation

arhiopterecs
Copy link
Contributor

@arhiopterecs arhiopterecs commented Sep 24, 2020

Purpose of this pull request

Added more extensive documentation for adding PHP extensions into the PHP images of Magento Cloud Docker
And small fixes

Affected DevDocs pages

whatsnew
Provided additional information about adding PHP extensions to Magento Cloud Docker by installing from PHP or PECL packages or by using an installation script. See Add a new PHP extension in the Cloud Guide.

oshmyheliuk and others added 6 commits September 3, 2020 13:19
…7810)

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

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

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>

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

Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>

Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>
* MCLOUD-6898: Add option to customize port for MailHog
* MCLOUD-6660: Add option to disable MailHog
* Update src/cloud/docker/docker-config.md

Co-authored-by: Margaret Eker <meker@adobe.com>
* MCLOUD-2789: [Cloud Docker] Add support for adding custom ES plugins from services.yaml file to the docker-compose.yml file.

Co-authored-by: Margaret Eker <meker@adobe.com>
@m2-community-project m2-community-project bot added this to Ready for Review in Pull Request Progress Sep 24, 2020
@devops-devdocs
Copy link
Collaborator

An admin must run tests on this PR before it can be merged.

src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
'<extension name>' => [ // this name will be used to identify the extension among other PHP extensions.
'<php version constraint>' => [ // for which PHP versions this config will apply
self::EXTENSION_TYPE => self::EXTENSION_TYPE_CORE // or self::EXTENSION_TYPE_PECL
self::EXTENSION_OS_DEPENDENCIES => ['<name dependency package 1>', <name dependency package 2>, ... ] // Linux packages, they will be installed in the order of indication before extantion
Copy link
Contributor

Choose a reason for hiding this comment

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

extantion - do you mean extension?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes

src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
@m2-community-project m2-community-project bot moved this from Ready for Review to Changes Requested in Pull Request Progress Sep 24, 2020
@BarnyShergold BarnyShergold added the Major Update Significant original updates to existing content label Sep 24, 2020
@meker12 meker12 added the Internal Dev Differentiates work between community and Magento staff label Sep 25, 2020
@meker12 meker12 self-requested a review September 26, 2020 00:01
@meker12 meker12 added Technical Updates to the code or processes that alter the technical content of the doc and removed Major Update Significant original updates to existing content labels Sep 26, 2020
@meker12 meker12 changed the base branch from Cloud-Docker-1.2.0 to mae-mcloud-6998-docker-add-php-extensions September 30, 2020 23:34
@meker12 meker12 changed the base branch from mae-mcloud-6998-docker-add-php-extensions to Cloud-Docker-1.2.0 October 2, 2020 03:59
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
For instance the following block adds the GNUPG extension:

```php?start_inline=1
We have divided the extensions into three conditional groups:
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be better to provide this information outside of the procedure after the sentence "In addition to built-in extensions..." on line 83.

We have divided the extensions into three conditional groups:

  • EXTENSION_TYPE_CORE– Extension that exists in the docker-php-source. For details, see the How to instal more PHP extensions section of the PHP, Docker Official Images page in Docker Hub.

src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
src/cloud/docker/docker-extend.md Outdated Show resolved Hide resolved
@meker12
Copy link
Contributor

meker12 commented Oct 2, 2020

@arhiopterecs Are these documentation changes specific to changes in Docker targeted for the 1.2.0 release?

If they are not dependent on the Docker release, please rebase this PR against the master branch. Thx.

arhiopterecs and others added 3 commits October 5, 2020 12:36
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
arhiopterecs and others added 12 commits October 5, 2020 12:40
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
@arhiopterecs arhiopterecs changed the base branch from Cloud-Docker-1.2.0 to master October 5, 2020 17:53
@meker12 meker12 changed the base branch from master to mae-mcloud-6998-docker-php-customization-updates-integration October 5, 2020 18:52
@meker12 meker12 self-requested a review October 5, 2020 18:53
Pull Request Progress automation moved this from Review in Progress to Reviewer Approved Oct 5, 2020
@meker12 meker12 merged commit fd9250c into magento:mae-mcloud-6998-docker-php-customization-updates-integration Oct 5, 2020
@ghost
Copy link

ghost commented Oct 5, 2020

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

@m2-community-project m2-community-project bot moved this from Reviewer Approved to Done in Pull Request Progress Oct 5, 2020
meker12 added a commit that referenced this pull request Oct 29, 2020
…ions (#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 <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
bdenham pushed a commit that referenced this pull request Oct 30, 2020
…ions (#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 <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
bdenham added a commit that referenced this pull request Nov 4, 2020
* 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 <barny.shergold@vaimo.com>
Co-authored-by: Margaret Eker <meker@adobe.com>

* 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 (#8144)

Co-authored-by: Margaret Eker <meker@adobe.com>

* 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 <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* 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 <meker@adobe.com>

* 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 <barny.shergold@vaimo.com>

* 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

Co-authored-by: Margaret Eker <meker@adobe.com>

Co-authored-by: Oleksandr Shmyheliuk <oshmyheliuk@magento.com>
Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com>
Co-authored-by: jfrontain <frontain@adobe.com>
Co-authored-by: Andrii Shevtsov <ashevtsov@magento.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Yevhen Miroshnychenko <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
meker12 added a commit that referenced this pull request Nov 9, 2020
* 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 <barny.shergold@vaimo.com>
Co-authored-by: Margaret Eker <meker@adobe.com>

* 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 <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>

* 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 <meker@adobe.com>

* 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 <barny.shergold@vaimo.com>

* 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 <oshmyheliuk@magento.com>
Co-authored-by: Andrii Shevtsov <ashevtsov@magento.com>
Co-authored-by: Margaret Eker <meker@adobe.com>
Co-authored-by: Yevhen Miroshnychenko <miroshny@adobe.com>
Co-authored-by: Barny Shergold <barny.shergold@vaimo.com>
Co-authored-by: hguthrie <hguthrie@users.noreply.github.com>
Co-authored-by: Jeff Matthews <matthews.jeffery@gmail.com>
Co-authored-by: Bohdan Korablov <korablov@adobe.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Development

Successfully merging this pull request may close these issues.

None yet

6 participants