After editing content, try it locally using yarn dev. Then create a branch and PR and wait for it to be linted before merging.
To install yarn, run npm install yarn -g.
To use yarn, first run yarn install at the root of this repository followed by yarn dev.
To publish content use the github action "deploy" and select the desired branch and stage to publish to.
This is a site template built with the Adobe I/O Theme.
View the demo running on Github Pages.
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 local development, simply use :
$ yarn install
$ yarn devFor the developer documentation, read the following sections on how to:
- Arrange the structure content of your docs
- Link to pages
- Use assets
- Set global Navigation
- Set side navigation
- Use content blocks
- Use Markdown
For more in-depth instructions.
-
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
For any team that wishes to deploy to the developer.adobe.com and developer-stage.adobe.com websites, they must be in contact with the dev-site team. Teams will be given a path that will follow the pattern developer.adobe.com/{product}/. This will allow doc developers to setup their subpaths to look something like:
developer.adobe.com/{product}/docs
developer.adobe.com/{product}/community
developer.adobe.com/{product}/community/code_of_conduct
developer.adobe.com/{product}/community/contribute
You can deploy using the GitHub actions deploy workflow see deploy instructions.