Adobe Commerce Cloud Tools

This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases of Commerce Cloud Tools, including:

• Cloud Docker for Commerce—For the Cloud Docker for Commerce source code, see the magento-cloud-docker repository.

Contributors

Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation.

See the Contribution Guide for details about contributing to Adobe Commerce and Magento Open Source developer documentation.

Local development

This repository is a Gatsby project that uses the Adobe I/O Theme.

Install the following for local documentation site builds:

• node— brew node
• corepack— brew corepack

To build and serve the site:

1. Clone the repository and change to site directory.

2. Enable the corepack package.

   corepack enable

3. Set yarn to stable version and install.

   yarn set version stable

   yarn install

4. Build site dependencies.

   The build command is useful for refreshing the build artifacts without serving the site, but yarn dev performs this step.

   yarn build

5. Build site and serve preview on localhost.

   yarn dev

   Use CTRL + C to stop serving the site.

6. Clean local build artifacts.

   yarn clean

Available Commands

Command	Description
yarn build	Compile site files.
yarn clean	Clean build artifacts.
yarn dev	Launch dev server preview.
yarn serve	Serve the existing site files for testing preview.
yarn start	Compile site files and serve for testing preview.
yarn test	Test for broken links.

Resources

See the following resources to learn more about using the theme:

• Arranging content structure
• Linking to pages
• Using assets
• Configuring global navigation
• Configuring side navigation
• Using content blocks
• Writing enhanced Markdown
• Deploying the site (Adobe employees only)

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