This topic explains how to document your service tile for Ops Manager.
When a VMware Tanzu service tile launches on VMware Tanzu Network, VMware publishes corresponding documentation at https://docs.pivotal.io under Partner Services for VMware Tanzu.
This documentation is formatted in Markdown, stored in a GitHub repository that VMware creates, and is published with the bookbinder platform.
The Partner Documentation Template is a GitHub repository that you can clone to create documentation for your service tile that follows the standard format for partner documentation. The template works with the documentation publishing platform, bookbinder.
Documentation content resides in the /docs-content folder of the repository, as skeleton pages with embedded prompts for content that you should fill in, approximately following the content descriptions below.
See the repository README.md for how to use the template with bookbinder to develop your documentation.
While the specifics of your documentation will vary depending on the product, we have provided a basic blueprint below. At minimum, documentation should include #1 (Overview) and #2 (Installing/Configuring).
For a good example of a partner service document, see the JFrog Artifactory documentation.
If you have questions or want to collaborate on drafting the documentation, feel free to hop on our Slack channel #tanzu-docs. We’re always happy to help!
General overview of Partner Product. What does it do? What are its features?
Key Features
A Service Broker allows Cloud Foundry applications to bind to services and consume the services easily from App Manager UI or command line. The Partner Service Broker will enable you to use one or more Partner accounts and is deployed as a Java Application on Cloud Foundry. The Broker exposes the Partner service on the Cloud Foundry Marketplace and allows users to directly create a service instance and bind it to their applications either from the Apps Manager Console or from the command line.
The Tile for Partner installs the Partner Service Broker as an application and registers it as a Service Broker on Cloud Foundry and exposes its service plans on the Marketplace. This makes the installation and subsequent use of Partner on your Cloud Foundry applications simple and easy.
If a trial license available, customers interested in using Partner can obtain a 60 day free trial license from edit link here.
Current Partner Tile for VMware Tanzu Details:
Provide any general or specific requirements here. A general requirement might be something like, “An AppDynamics account.” A specific requirement might be something like, “Packaging Dependencies for Offline Buildpacks.”
Any known limitations.
Please provide any bugs, feature requests, or questions to the Ops Manager Feedback list.
This topic provides instructions for how to install and configure the tile. Typically this includes procedures for how to download the tile from VMware Tanzu Network, install it on Ops Manager, configure the tile, and do any required third-party configuration. Screenshots should be provided where necessary. Consult the following format:
If there are any specific instructions for upgrading the tile, you can include those here. If the procedures are complicated, create a new Upgrading topic.
Add snapshots for each step when possible or add details as required.
On completion of Partner Tile install, check Services Marketplace in Apps Manager:
Provide information for specific configurations like configuring for HTTP proxy, or doing any necessary configurations on a third-party service portal.
This topic provides instructions for how to use the tile. Typically this includes procedures for how to perform the different functions offered by the service. Screenshots should be provided where necessary. You can also include information about Architecture here if necessary.
This topic provides troubleshooting information for known errors, following the Symptom/Explanation format used here: https://docs.pivotal.io/p-identity/okta/troubleshooting.html
Include the release notes as the final topic, following the format in the docs-partners-template.
