Solution Best Practices

There are many ways you can ensure your customers have the best possible experience with your solution; providing Getting Started documentation is a great first step.

Getting Started documentation

Every solution must be accompanied by a Google Cloud Platform-specific Getting Started document that helps your customers with detailed deployment and configuration steps for your solution. The documentation must be created and maintained by you on your website. We suggest that you co-brand the page with the Google Cloud Platform logo, available at the Cloud Connect site. (Note that Cloud Connect requires you to register to access the site.)

Please apply the following guidelines when creating the Getting Started documentation.

Overall:

  • The document should provide step-by-step guidance along the customer’s journey starting with the solution page on the GCP Marketplace site, all the way through to the deployment and configuration of the solution.

Deployment:

  • The document should provide the customer with guidance on the inputs they will have to provide for to a successful deployment. We recommend interlacing the document with screenshots in addition to instructions in text. For example, we suggest that you provide guidance on the following configuration items:

    • What is the recommended machine configuration, disk sizes, zones, and so on?

    • Does the customer have to open any ports, particularly 80, 443?

    • Are the needed ports opened by default or does the customer have to open these ports during the deployment flow?

Post deployment next steps:

  • The document should outline if and how the customer will gain access to an admin page or console URL and how login credentials can be obtained.

  • The Instructions should outline how the customer:

    • Can SSH into the virtual machine instance

    • Can access a list of open source components’ licenses along with source code on the instance (if any)

    • Can check status or health of the application

  • Lastly, the document should list any additional commands needed to configure the solution.

For additional guidance you can refer to these example pages that have been developed for other solutions in GCP Marketplace:

After you've created a draft, please send an email with the URL to your draft to your assigned Partner Engineer for review and feedback.

Оцените, насколько информация на этой странице была вам полезна:

Оставить отзыв о...

Текущей странице
GCP Marketplace