[英]Where to put Bluemix Service documentation
I have created a Bluemix Service and can see it in my Bluemix dashboard, under Services. 我已经创建了一个Bluemix服务,并且可以在我的Bluemix仪表板中的“服务”下看到它。
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.
第1列第1行的错误:文档为空下面是直到第一个错误的页面呈现。
It seems like I need to provide a documentation. 似乎我需要提供一个文档。 But where do I put that in my source code directory?
但是,我应该将其放在源代码目录的什么位置?
The service metadata has a field documentationURL
that can be used to point to the related documentation. 服务元数据具有字段
documentationURL
,可用于指向相关文档。 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 . 此字段和其他字段(例如,
dashboard_client
(用于服务仪表板))记录在Cloud Foundry目录元数据的“ 服务元数据字段 ”部分中。
To see a working example you can take a look at my Pseudo Broker/Service sample that I wrote for Bluemix. 要查看一个有效的示例,您可以看一下我为Bluemix编写的Pseudo Broker / Service示例 。 It has the bare minimum code and step-by-step instructions.
它具有最低限度的代码和逐步说明。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.