This is the new Linode developers site. It provides documentation to complement the APIv4. Currently this software is early-access and is available at developers.linode.com.
brew install yarn
git clone https://github.com/linode/linode-api-docs.git
cd linode-api-docs
node --version # should be 8.4.0
yarn
Run:
yarn start
to run the prebuild script and start the development server. Connect to localhost:5000 to try it out. Most of the changes you make will be applied on the fly, but you may occasionally find that you have to restart it.
We use gitchangelog to generate our changelogs for this repository. Please begin commit messages with one of these prefixes to have them included in the changelog:
| Tag | Meaning | | new | Features | | bug | Bug Fixes | | ref | Refactors | | brk | Breaking Changes |
If you have more information to include in the changelog, include them as bullet points below, starting the line with an asterisk.
Example:
new: Added docs for /some/thing
This text is ignored
* More information in the changelogThis will produce the following output:
Features:
* Added docs for /some/thing
* More information in the changelog
The prebuild.js script converts yaml into a js file imported by the app.
Prebuild builds a json tree of endpoint indices, endpoints, and methods with
the associated resource objects.
The Linode Manager's code is distributed under the terms of the BSD 3-clause license. The assets are not licensed for any purpose without prior written approval from Linode, unless otherwise noted.