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

Add docker-compose support #6890

Merged
merged 9 commits into from
Mar 20, 2020
Merged

Add docker-compose support #6890

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0d86b00
Add docker-compose support
cmuench Mar 19, 2020
1e150bb
Fix markdown style violations
cmuench Mar 19, 2020
364b7db
Added additional description of docker setup
cmuench Mar 19, 2020
015f7e4
Update README.md
cmuench Mar 19, 2020
92204b1
Add further instruction of the docker setup
cmuench Mar 19, 2020
c18bb08
Fix lint errors
cmuench Mar 19, 2020
4a0492f
Remove trailing spaces
cmuench Mar 19, 2020
eec2235
Remove wrong quotes
cmuench Mar 19, 2020
53798cd
Merge branch 'master' into docker-compose-setup
hguthrie Mar 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This site is built by [Jekyll](https://jekyllrb.com/), which is an open-source t
You can build the site locally in the following ways:

- [Installing the project dependencies locally](#build-locally) (Mac, Linux)
- [Using Docker (docker-compose)](#docker-docker-compose) (Mac, Linux, Windows)
- [Using a Vagrant virtual machine](https://github.com/magento-devdocs/vagrant-for-magento-devdocs) (Mac, Linux, Windows)
- [Build DevDocs in Windows](https://github.com/magento/devdocs/wiki/Build-DevDocs-in-Windows) (Windows 7 & 10)
- [Building older versions of the documentation](#building-old-versions)
Expand Down Expand Up @@ -141,6 +142,20 @@ exclude:
>rake preview:all
>```

## Docker (docker-compose)
Copy link
Contributor

Choose a reason for hiding this comment

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

To add some context to this feature, can you add the following information in a summary before the instructions:

  1. What are the use cases for using this feature?
  2. Do users need anything else besides docker installed?
  3. Will this work from a fresh copy of the repo or do people need to perform some pre-requisite steps?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's quite simple. Only a docker installation is needed. Should work in every repo/fork. I can add an additional comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jcalcaben I added an description. Please review it. I am not a native speaker.


1. Install docker
hguthrie marked this conversation as resolved.
Show resolved Hide resolved

1. Run docker-compose command:
hguthrie marked this conversation as resolved.
Show resolved Hide resolved

```bash
docker-compose up
```

Open your browser (http://127.0.0.1:4000)
hguthrie marked this conversation as resolved.
Show resolved Hide resolved

hguthrie marked this conversation as resolved.
Show resolved Hide resolved
1. Press `Ctrl+C` in the serve terminal to stop the server.

## Building old versions

The published website contains documentation for the latest Magento releases only. For cases, when you need to view the content as it was for an earlier release, we created [tags](https://github.com/magento/devdocs/tags) in this repository. Typically, they point at the commit when the release notes were finalized and published.
Expand Down
11 changes: 11 additions & 0 deletions docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: '3.6'

services:
jekyll:
image: jekyll/jekyll:latest
command: jekyll serve --watch --incremental --open-url --livereload
ports:
- 4000:4000
- 35729:35729
volumes:
- .:/srv/jekyll