Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.47 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.47 KB
Raw

API Connect Toolkit CLI Documentation

This website is built using Docusaurus 2, a modern static website generator.

The website is published here: https://ibm-apiconnect.github.io/clidocs/

Doc generation

The makes for each individual command are generated using the apic CLI downloaded from the API Manager of a stack of an appropriate version. Make sure you are using the release branch correct for that version. Then run apic docs -m {mode} to create a docs subdirectory with the markdown files in it. Then copy those to the right place in the clidocs tree, and run it again for a different mode, repeat until you have worked your way through all the modes.

Don't forget to git add any new files for new commands that have been added.

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

This command will build the website and push to the gh-pages branch. Do not push to the gh-pages branch directly yourself, only via the deploy command.