Where to put Bluemix Service documentation

Question

I have created a Bluemix Service and can see it in my Bluemix dashboard, under Services.

When I go into my service, under the Manage tab, there is a button, "Open my-service-name Dashboard". When I click on it, I am taken to a page saying

This page contains the following errors:

error on line 1 at column 1: Document is empty Below is a rendering of the page up to the first error.

It seems like I need to provide a documentation. But where do I put that in my source code directory?

Answer 1

The service metadata has a field documentationURL that can be used to point to the related documentation. This and other fields like the dashboard_client (for the service dashboard) are documented in the Cloud Foundry Catalog Metadata in the section on Services Metadata Fields.

To see a working example you can take a look at my Pseudo Broker/Service sample that I wrote for Bluemix. It has the bare minimum code and step-by-step instructions.