From 494f54ef609bb702c8c17ef7a2988b46fa6e46c0 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Wed, 1 Apr 2020 09:54:50 -0500 Subject: [PATCH] Moved Docker/DevDocs build steps to the wiki --- README.md | 31 +------------------------------ 1 file changed, 1 insertion(+), 30 deletions(-) diff --git a/README.md b/README.md index aa36d0e5e37..86d8006788f 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.