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
$ yarn dev

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

Launching a deploy

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

GraphQL API reference generator

The GraphQL API reference is generated using an open-source tool SpectaQL. The data required for the generator is located at the spectaql directory:

• adobe-theme: custom theme.
• config.yml: configuration file.
• schema.json: the GraphQL schema extracted from the Adobe Commerce (B2B) instance.

The resulted GraphQL API reference lives in the static/graphql-api/ directory. It is embedded into the /graphql/reference page using the frameSrc feature on the DevSite.

To rebuild the GraphQL API reference after any updates, run:

yarn build:spectaql

To run SpectaQL in the development mode:

yarn dev:spectaql

How to get the schema

The website in the public directory was generated for the Adobe Commerce with B2B instance from GraphQL Schema 'schema.json'. The schema was retrieved using the apollo-cli tool:

npx apollo-cli download-schema $ENDPOINT_URL --output schema.json

where $ENDPOINT_URL is a placeholder for a URL's endpoint.

For more information about SpectaQL, refer to https://github.com/anvilco/spectaql.