App Builder Docs

This site is built with Adobe I/O Theme.

Follow the instructions to get started.

Main branch is auto-published to github pages here Note, this is not the full site, and this url is not shared. This is a very quick way to go and verify relative links and general formatting before running the deployment workflows.

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.

Prerequisite: Install Yarn 3

This site uses Yarn 3 to manage package dependencies. If you do not have Yarn 3 installed, follow these instructions:

1. Install Node.js LTS. At the time of writing, the latest LTS version is v16.15.1.

2. Install Yarn 3 by running the following command:

   corepack enable

Corepack is a binary shipped with all Node.js releases starting from 16.10.

3. Update Yarn to the latest version by running the following command:

   yarn set version stable

4. Make sure you are now using version 3.2.2 of Yarn:.

   yarn --version

That's it. For more information on Yarn 3 usage, see Yarn usage.

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

How to build the site locally

After installing yarn v3 as noted above, you can develop locally by running the following commands:

1. Install the dependencies:

   yarn install

2. Run a development build:

   yarn dev

3. Open home page:

   open http://localhost:8000/overview

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

Launching a deploy

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