Adobe I/O Documentation Template

This is 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.

How to develop

For local development, simply use :

$ yarn install
$ yarn dev

(also use yarn clean)

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 test

• To run the configured linters locally (requires Docker):

  yarn lint

  NOTE If you cannot use Docker, you can install the linters separately. In .github/super-linter.env, see which linters are enabled, and find the tools being used for linting in Supported Linters.

• To check internal links locally

  yarn test:links

• To build and preview locally:

  yarn start

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.

Redirections

• https://developer.adobe.com/indesign/uxp/guides/ -> https://developer.adobe.com/indesign/uxp/
• https://developer.adobe.com/indesign/uxp/server/ -> https://developer.adobe.com/indesign/uxp/
• https://developer.adobe.com/indesign/uxp/recipes/ -> https://developer.adobe.com/indesign/uxp/
• https://developer.adobe.com/indesign/uxp/uxp-scripting-samples/ -> https://developer.adobe.com/indesign/uxp/

URLs

During InDesign v18.5 release, we revamped the information architecture of the whole site. This will break previously (prior to v18.5) bookmarked URLs.

Search metadata

• Add titles and descriptions at a minimum (https://github.com/adobe/aio-theme#frontmatter). No titles mean no indexing.
• Keywords help with Google SEO but only work as filters within dev site

Contribute

Recipes

Use the template for recipes and make sure you provide all the necessary details. Open a pull request.