Куда разместить документацию по службе Bluemix

Я создал службу Bluemix и вижу ее на панели инструментов Bluemix в разделе "Службы".

Когда я захожу в свой сервис, на вкладке «Управление» есть кнопка «Открыть панель мониторинга my-service-name». Когда я нажимаю на нее, я попадаю на страницу с сообщением

Эта страница содержит следующие ошибки:

ошибка в строке 1 в столбце 1: документ пуст. Ниже показано отображение страницы до первой ошибки.

Похоже, мне нужно предоставить документацию. Но где мне поместить это в каталог с исходным кодом?


person daniely    schedule 06.02.2017    source источник
comment
Вы предоставили услугу из каталога или добавили в Bluemix свою собственную? Если последнее, зарегистрировали ли вы брокера?   -  person data_henrik    schedule 07.02.2017
comment
Я добавляю свою собственную службу в Bluemix, я зарегистрировал брокера служб, но я не вижу поля, которое указывает эту страницу в json, возвращаемом из / v2 / catalog   -  person daniely    schedule 07.02.2017


Ответы (1)


В метаданных службы есть поле documentationURL, которое можно использовать для ссылки на соответствующую документацию. Это и другие поля, такие как dashboard_client (для панели управления сервисом), задокументированы в каталоге Cloud Foundry. Метаданные в разделе Поля метаданных служб .

Чтобы увидеть рабочий пример, вы можете взглянуть на мой образец псевдоброкера / службы, который Я писал для Bluemix. Он содержит минимум кода и пошаговые инструкции.

person data_henrik    schedule 07.02.2017
comment
Спасибо, Хенрик, кажется, что URL-адрес документации - это страница, которая появляется, когда вы нажимаете ..., а затем нажимаете «Просмотреть документы». Страница, о которой я говорю, - это страница на вкладке «Управление», где написано: «Открыть панель мониторинга my-app-name». Где я могу указать, на какую страницу я попаду? - person daniely; 07.02.2017
comment
Я добавил информацию о дашборде. Это тоже есть в моем примере. - person data_henrik; 07.02.2017