Magento Developer Documentation
HTML JavaScript CSS Other
bdenham Commerce installation additions for 2.3 alpha install (#2547)
* First draft of commerce installation additions for 2.3 alpha install

* Added info and link for installing Commerce B2B extension

* Updated composer commands to fit new numbered alphas

* Update 2.3.0-alpha-install.md

Modified B2B wording
Latest commit a9aaa8d Jul 20, 2018
Permalink
Failed to load latest commit information.
.github Update PR template format and new change type Jul 17, 2018
_data MAGECLOUD-1837 update bitbucket integration (#2490) Jul 17, 2018
_includes Merge pull request #2439 from magento/ds_MAGEDOC-2812_upgrade-instr Jul 20, 2018
_layouts Fix the turorial back link Jun 15, 2018
_plugins Fixed version switcher issue on the landing page Jun 7, 2018
_videos Wrong file & don't need cat + pipe (#2335) Jun 22, 2018
bin Add jekyll binstub Jul 27, 2015
codelinks Update attributes.md May 25, 2018
common Sort contributors by number of accepted PR’s Jul 18, 2018
community/resources Revise and convert tutorial Jun 11, 2018
guides Commerce installation additions for 2.3 alpha install (#2547) Jul 20, 2018
i Add new logo and remore unused assets Jun 27, 2018
js Sort contributors by number of accepted PR’s Jul 18, 2018
schemas first draft of REST docs Oct 8, 2015
scss Put back the 2.0 deprecation warning Jun 7, 2018
swagger Merge pull request #2444 from mage2pratik/patch-3 Jul 10, 2018
.gitignore Merge remote-tracking branch 'origin/2.3.0-beta' into 2.3.0-beta May 11, 2018
404.md unify brackets for 'site.baseurl' May 14, 2018
CNAME Create CNAME Jan 22, 2015
Dockerfile DEVOPS-1907: added Dockerfile and docker-compose.yml Jan 11, 2018
Gemfile MAGEDOC-2949: Upgrade gh-pages in Gemfile May 8, 2018
Gemfile.lock Update logo to match branding team recommendations Jun 27, 2018
README.md Add link to CONTRIBUTING from README Jul 3, 2018
Rakefile Add 'bundle install' to 'preview' task May 8, 2018
_config.yml Merge pull request #2396 from magento/MAGEDOC-3040-rss-feed Jul 19, 2018
docker-compose.yml DEVOPS-1907: added Dockerfile and docker-compose.yml Jan 11, 2018
favicon.ico Correct Favicon Jun 13, 2015
feed.xml MAGEDOC-3040: Improve load time Jul 9, 2018
gulpfile.js Merge branch 'develop' of https://github.com/magento/devdocs_internal Apr 30, 2018
index.html Reverted the layout Jun 7, 2018
magento-release-information.md MAGETWO-69760: Breaking Changes Sep 27, 2017
magento-techbull.md unify brackets for 'page.baseurl' May 14, 2018
magento-third-party.md MAGETWO-72128: [Devdocs site] Update EE labels on devdocs Sep 28, 2017
package-lock.json Updated the gulp configuration for devdocs Apr 26, 2018
package.json Merge branch 'develop' of https://github.com/magento/devdocs_internal Apr 30, 2018
robots.txt MAGEDOC-2834: Remove 2.0 noindex directive May 14, 2018
search.md Version-specific search page Sep 11, 2017
system-requirements.md MAGEDOC-2917 Add system-requirements.md to devdocs root (#1895) Apr 18, 2018
videos.html Videos section organization Jan 12, 2017

README.md

Magento Developer Documentation

Welcome! This site contains the latest Magento developer documentation for ongoing Magento 2.x releases. For additional information, see our Contributions Guide.

To contribute, please fork the develop branch.

Building this site

You can build this site locally in the following ways:

Build using Jekyll

For local builds, you need to install Ruby 2.4 or later.

To check the Ruby version on your environment, run in your terminal:

$ ruby -v

Install the latest Ruby (if the Ruby version is less than 2.4)

MacOS users

  1. Install Homebrew. See the Homebrew site for instructions.

  2. Use Homebrew to install the latest stable version of Ruby:

    $ brew install ruby
    

Unix, Windows and other OS users

See the Ruby site for instructions.

Install Bundler

Install the Bundler gem, which helps with Ruby dependencies:

$ gem install bundler

Once you have completed preparing your environment, you can build locally and review the site in your browser.

Install devdocs

Clone or download the repository. The first time you are at the devdocs directory, run:

$ bundle install

Once you have completed preparing your environment, you can build locally and review the site in your browser.

To build locally:

Using rake

rake is a native Ruby tool that helps to automate tasks.

  1. Run the rake task that installs all required dependencies and starts the Jekyll server:

    $ rake preview
    
  2. Press Ctrl+C in the serve terminal to stop the server.

If rake fails on your environment, generate the preview using jekyll.

Using jekyll

  1. The first time you are at the devdocs directory or when you need to pick up changes in Gemfile.lock dependencies (for example, theme changes), run:

    $ bundle install
    
  2. To generate the local preview, run:

    $ bundle exec jekyll serve --incremental
    
     Configuration file: /Users/username/Github/devdocs/_config.yml
                 Source: /Users/username/Github/devdocs
            Destination: /Users/username/Github/devdocs/_site
      Incremental build: enabled
           Generating...
                         done in x.x seconds.
      Auto-regeneration: enabled for '/Users/username/Github/devdocs'
         Server address: http://127.0.0.1:4000//
       Server running... press ctrl-c to stop.
    
  3. Use the Server address URL http://127.0.0.1:4000/ in a browser to preview the content.

  4. Press Ctrl+C in the serve terminal to stop the server.

TIP Leave the serve terminal open and running. Every time you save changes to a file, it automatically regenerates the site so you can test the output immediately. Changing the _config.yml file requires a fresh build. Using the --incremental option limits re-builds to posts and pages that have changed.

To minimize build time locally:

  1. Create a _config.local.yml file at the root of the project directory and exclude all versions except the one that you want to preview. The following example will generate Magento 2.2 documentation only.

     exclude:
      - /community/
      - /swagger/
      - /vagrant/
      - /guides/m1x/
      - /guides/v2.0/
      - /guides/v2.1/
     # - /guides/v2.2/
      - /guides/v2.3/
    
     # Excluded in config.yml
      - /scss/
      - /bin/
      - /node_modules/
      - /vendor/
      - /.*
      - /Rakefile
  2. Run the preview command:

    $ rake preview
    

    This command:

    • Checks your environment according to the dependencies in Gemfile.lock.
    • Removes the _site/ directory, which contains previously generated preview files.
    • Generates a new preview and opens the landing page in a web browsers.

If you don't have the _config.local.yml file at the root of your devdocs/ directory, the rake will generate all versions of the documentation.

Build using Docker

This repository comes with the necessary configuration files for building a local copy of the Magento DevDocs with Docker, using Docker Compose.

To use Docker and Docker Compose, first download and install Docker for the appropriate operating system, and then install Docker Compose to execute the docker-compose.yml configuration file.

Docker for Mac

  • Refer here for the official installation instructions.

Docker for Windows

  • Refer here for the official installation instructions.

Docker Compose

  • Refer here for the official installation instructions.

Execution Steps

  1. Using git, clone this repository.
  2. Navigate to the resulting directory.
  3. Run docker-compose up to initialize the build process. Refer here for more details on the use of docker-compose.
  4. Visit http://localhost:4000/ in a web browser, and you should be presented with a local copy of the Magento DevDocs. The configuration for the local port (4000 by default) is found in the docker-compose.yml file. If another port is desired, please refer here for further details regarding Docker Compose port mapping.

Addressing Problems With Docker Build

  1. Verify that the Docker engine is installed for the appropriate operating system.
  2. Verify that Docker Compose is installed.
  3. Verify that this repository has been cloned.
  4. Verify that the correct Docker Compose command(s) have been used in the same directory as the docker-compose.yml file.
  5. If there are still problems, please open an Issue on this repository.

Build using Vagrant

You can deploy the devdocs site locally using this Vagrant project.


If you have questions, open an issue and ask us. We're looking forward to hearing from you!