在哪里放置 Bluemix 服务文档

Where to put Bluemix Service documentation

我已经创建了一个 Bluemix 服务,并且可以在我的 Bluemix 仪表板中的“服务”下看到它。

当我进入我的服务时,在“管理”选项卡下,有一个按钮 "Open my-service-name Dashboard"。当我点击它时,我被带到一个页面说

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.

看来我需要提供一个文档。但是我应该把它放在我的源代码目录中的什么地方呢?

服务元数据有一个字段documentationURL,可用于指向相关文档。 dashboard_client(用于服务仪表板)等其他字段记录在 Cloud Foundry Catalog Metadata in the section on Services Metadata Fields.

要查看工作示例,您可以查看我为 Bluemix 编写的 Pseudo Broker/Service sample。它具有最少的代码和 step-by-step 说明。