Add docker-compose support #6890
Conversation
magento-engcom-team
added
partners-contribution
|
An admin must run tests on this PR before it can be merged. |
|
This builds properly for me. |
| @@ -141,6 +142,20 @@ exclude: | |||
| >rake preview:all | |||
| >``` | |||
|
|
|||
| ## Docker (docker-compose) | |||
There was a problem hiding this comment.
To add some context to this feature, can you add the following information in a summary before the instructions:
- What are the use cases for using this feature?
- Do users need anything else besides docker installed?
- Will this work from a fresh copy of the repo or do people need to perform some pre-requisite steps?
There was a problem hiding this comment.
It's quite simple. Only a docker installation is needed. Should work in every repo/fork. I can add an additional comment.
There was a problem hiding this comment.
@jcalcaben I added an description. Please review it. I am not a native speaker.
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: review
labels
Co-Authored-By: hguthrie <hguthrie@users.noreply.github.com>
| ## Docker (docker-compose) | ||
|
|
||
| Docker provides a quick and easy way to build and preview the documentation. You do not need to install Ruby dependencies manually. This Docker solution launches Jekyll inside the container in `watch` mode.``` | ||
| ruby dependency manually. The provided setup starts Jekyll inside the container in watch mode. |
There was a problem hiding this comment.
You don't need this line now, since the updates were made. 🙂
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
hguthrie
added
the
Technical
|
running tests |
|
Hi @cmuench, thank you for your contribution! |
dshevtsov
removed
the
Technical
|
The |
jeff-matthews
added
the
Technical
|
Adding the label back in recognition of the contributor's efforts. It's not a common use case, so I'm allowing an exception this time. |
|
@jeff-matthews thanks. Thought... a simple Docker setup can help to speed up the onboarding process. So more people can contribute. |
Purpose of this pull request
This pull request (PR) adds support for Docker to quickly setup the project. This speeds up onbording of new devdocs contributors.
Added the ability to build and preview DevDocs in a Docker container. See the DevDocs Readme for directions.