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

Commit

Permalink
Moved Docker/DevDocs build steps to the wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
jeff-matthews authored Apr 1, 2020
1 parent c9bcff9 commit 494f54e
Showing 1 changed file with 1 addition and 30 deletions.
31 changes: 1 addition & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can build the site locally in the following ways:
- [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)
- [Building older versions of the documentation](https://github.com/magento/devdocs/wiki/Build-DevDocs-with-Docker)

## Build locally

Expand Down Expand Up @@ -142,35 +142,6 @@ exclude:
>rake preview:all
>```
## 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.
Every change of a markdown file automatically triggers a rebuild of the documentation.
1. Install [Docker](https://www.docker.com/get-started). If you have Docker installed, launch the Docker application.
1. Clone the DevDocs repository.
1. Change to the `devdocs` directory.
1. Build and start the Docker environment.
```bash
docker-compose up
```
1. Use the server address URL provided by the system response.
For example:
```terminal
jekyll_1 | Server address: http://127.0.0.1:4000/
jekyll_1 | Server running... press ctrl-c to stop.
```
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

0 comments on commit 494f54e

Please sign in to comment.