APIs for updating developer portal documentation (pages/partials) programmatically

Latest response

Can anyone point me to documentation about an API for updating the contents of our documentation programmatically? We are generating a long list of partials with scripts and want to upload them to the site via APIs for efficiency. Thanks.

Responses

There is a tool called "3scale-cms" written in Ruby which can do the following actions:

The cms command has five actions:

  • info - show information about contents of the CMS and the local files. It accepts the optional parameter: 'details'
  • diff - show the difference in contents between the CMS and the local files. It accepts the optional parameter: 'details'
  • download - download all the contents of the CMS (no parameter). Or specify a file or section (with its contents) to download
  • upload - upload all the local files (no parameter). Or specify a file or section (with its contents) to upload
  • delete - delete all (that can be deleted) or a specific entry in the remote CMS

It is not supported but don't know if it is published somewhere, like Github?! I have also modified it a bit since it didn't handle line breaks properly on Windows.

Red Hat: Can you make it available on Github?

Joacim, where did you get your copy of 3scale-cms?

@Ariel I uploaded it to Github for now (mostly original but have made a few minor adjustments) https://github.com/4integration/3scale-cms

Thank you!

Close

Welcome! Check out the Getting Started with Red Hat page for quick tours and guides for common tasks.