This projects builds the documentation for the Cloud Manager API using the Adobe I/O Gatsby Theme.
- Node 14.x
- Yarn 1.22.x
For local development, simply use :
$ yarn install
$ yarn dev
You can deploy using the GitHub actions deploy workflow see deploy instructions.
Creating a new guide page generally consists of three steps (and one optional step):
- Create a new Markdown file under
pages/guides/api-usage
orpages/guides/getting-started
. More likely the former than the latter. - Adding a new
DiscoverBlock
to theindex.md
file in one of those directories (the same directory the new guide is in) -- this will automatically cause the guide block to appear on the/guides
page in the appropriate section. - Add a new page item to
gatsby-config.js
-- this will cause the guide to appear in the navigation. - (if appropriate) Add a new
DiscoverBlock
topages/index.md
-- this will cause the guide to appear on the home page.
If you are running yarn dev
the whole time, you should be able to instantly view your changes.