devdocs

[Deprecated] Magento Developer Documentation

magento
674
1759
Ruby

Adobe Commerce Developer Documentation

This project contains the source code of the Adobe Commerce and Magento Open Source developer documentation website for the latest 2.3 release.

Important update

Adobe Commerce and Magento Open Source 2.4.x documentation has been migrated to Adobe sites. See our new landing pages to access the most current information.

Adobe Commerce Developer Documentation (Adobe Developer site)—Develop, customize, integrate, extend, and use advanced capabilities

Adobe Commerce Documentation (Adobe Experience League)—Plan, implement, operate, upgrade, and maintain your Commerce projects

Some content was consolidated or moved to different guides. If you have trouble finding a topic, see the Migrated topics.

We welcome contributions to migrated content! You can find similar links to GitHub on the Adobe sites.

The content at https://devdocs.magento.com is no longer supported since the 2.3 release line has reached end of support.

Building this site

This site is built by Jekyll, which is an open-source tool developed in Ruby.

You can build the site locally in the following ways:

Build locally

You do not need to set up a webserver to serve the site locally. Jekyll will use its own webserver for this.

Set up Ruby

Consider to set up the Ruby version defined in .ruby-version.
Ruby version manager such as rvm or rbenv can help to manage the correct version for this automatically.

See official documentation for the most recent installation guidelines and available options.

Install devdocs

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

bundle install

The website file structure contains directories pulled from multiple sources, not only this repository. The full list with mapped directories is defined in the Docfile.yml. It includes public and private repositories.
To pull all the mapped sources:

rake init

Docfile begins with public sources, because the rake init task fails when it attempts to clone content from private repositories without the corresponding permissions.

NOTE
By default rake clones using SSH. If you want to clone with HTTPS, you can run it with the token variable:

token=none rake init

Use none if you do not want to use a real token. To have access to private repositories, you will need a GitHub token with the relevant access permissions.

TIP
All the helper CLI commands for this project are implemented using rake.
Use the rake --tasks command for a complete list of available tasks, or filter the list using a keyword, such as rake --tasks test.

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

Run the website

  1. Using the following rake task, verify all the required dependencies and start the embedded web server:

    rake preview

    You will see the commands called by the rake task and the corresponding output. Each command is typically highlighted with the magenta color:

    ~/magento/devdocs (master)$ rake preview
Install gems listed in the Gemfile: $ bundle install
Using rake 13.0.1
Using public_suffix 4.0.3
<truncated>
Bundle complete! 16 Gemfile dependencies, 70 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Installed!
Cleaning after the last site generation: $ bundle exec jekyll clean
Configuration file: /Users/user/magento/devdocs/_config.yml
          Cleaner: Removing /Users/user/magento/devdocs/_site...
          Cleaner: Removing src/.jekyll-metadata...
          Cleaner: Removing src/.jekyll-cache...
          Cleaner: Nothing to do for .sass-cache.
Clean!
Enabled the default configuration: $ bundle exec jekyll serve --incremental \
                                --open-url \
                                --livereload \
                                --trace \
                                --plugins _plugins,_checks
Configuration file: /Users/user/magento/devdocs/_config.yml
Theme Config file: /Users/user/.rvm/gems/ruby-2.6.5/bundler/gems/devdocs-theme-e1a4ff6880d5/ _config.yml
            Source: /Users/user/magento/devdocs/src
      Destination: /Users/user/magento/devdocs/_site
Incremental build: enabled
      Generating...
Running ["ImageCheck", "HtmlCheck", "LinkCheck", "ScriptCheck",  "LinkChecker::DoubleSlashCheck"] on ["/Users/user/magento/devdocs/_site"] on *.html...


Ran on 1747 files!


HTML-Proofer finished successfully.
                    done in 220.316 seconds.
Auto-regeneration: enabled for 'src'
LiveReload address: http://127.0.0.1:35729
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.
        LiveReload: Browser connected

  2. The generated website launches automatically in a new tab in your browser.

  3. 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 or other YAML file with data or configuration requires a fresh build (stop and start the server again with rake preview).

Building old versions

The published website contains documentation for the latest 2.3.x Adobe Commerce and Magento Open Source release only. For cases, when you need to view the content as it was for an earlier release, we created tags in this repository. Typically, they point at the commit when the release notes were finalized and published.

To view the list of available tags:

git tag --list

To checkout the version (for example 2.2.0):

git checkout 2.2.0

Find guidelines for building the site locally in the checked out README.

NOTE
There is no guarantee the site will be built, since it can have dependencies on the external resources that are not available anymore.

Archived docs

To view the archived documentation, see https://commerce-docs.github.io/devdocs-archive/.

Our public channels: