Adobe Commerce Cloud Tools

This repository contains the content for Commerce Cloud Tools, including:

• Cloud Docker—For the tool, see the magento-cloud-docker repository.

Install the following for local documentation site builds:

• node— brew node
• corepack— brew corepack

Build local and preview the site

1. Clone site 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. (Optional) Build site dependencies. This is useful if you want to refresh the build artefacts without serving the site, but yarn dev performs this step.

   yarn build

5. Build site on localhost.

   yarn dev

   Use CTRL + C to stop serving the site.

6. After you finish with preview, you can clean local build artifacts.

   yarn clean

   You can use yarn dev to launch the site again.

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:links	Test for broken links.

Repository Template

This repository uses a site template built with the Adobe I/O Theme.

View the demo running on Github Pages.

Where to ask for help

The slack channel #adobeio-onsite-onboarding is our main point of contact for help. Feel free to join the channel and ask any questions.

For the documentation developer, please read these sections on how to:

• Arrange the structure content of your docs
• Linking to pages
• Using assets
• Setting Global Navigation
• Setting Side Navigation
• Using content blocks
• Notes on using Markdown

For more in-depth instructions.

How to deploy

For any team that wishes to deploy to the adobe.io and stage.adobe.io website, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern adobe.io/{product}/. This will allow doc developers to setup their subpaths to look something like:

adobe.io/{product}/docs
adobe.io/{product}/community
adobe.io/{product}/community/code_of_conduct
adobe.io/{product}/community/contribute

You can deploy using the GitHub actions deploy workflow see deploy instructions.