IBM Cloud Docs
Defining your catalog entry and product page

Defining your catalog entry and product page

During the onboarding process, you provide certain details about your product that are displayed in the IBM Cloud® catalog. The details include your product logo and description, a list of product features, supporting media, and a link to your warranted product documentation.

Defining your catalog entry

The contents of a catalog entry include the company or product logo, a short description about the product, and other details. Because the catalog entry is visible to users as they browse the IBM Cloud catalog, provide clear details that can help users find your product.

Providing a short description of your product

  1. Click Enter description.
  2. Enter a short description of what your product is, its value, and any other details that you want to be displayed in your catalog entry.
  3. Click Save.

Selecting your catalog category

Users can filter the catalog to display similar products based on common solutions, function, or use.

  1. Click Select category.
  2. From the list, select the category that best describes your product. For a description of each category, see the following table.

Category types

The following table describes each type of category that you can select.

Table 1. Category descriptions
Category Description
AI / Machine Learning Products that enable systems to learn from data rather than through explicit programming.
Analytics Products that facilitate the analysis of data, typically large sets of business data, by the use of mathematics, statistics, and other means.
Blockchain Products that facilitate the process of recording transactions and tracking assets in a business network.
Compute Infrastructure resources that serve as the basis for building apps in the cloud.
Containers A standard unit of software that packages up code, and all its dependencies, so the app runs quickly and reliably from one computing environment to another.
Databases Products that provide some form of access to a database without requiring setting up physical hardware, installing software, or configuring for performance.
Developer tools Products that support developing, testing, and debugging software.
Enterprise applications Bundle of compatible products that deliver enterprise-grade app solutions for information sharing, automation, and agility.
Integration Products that facilitate the connection of data, apps, APIs, and devices across an organization to be more efficient, productive, and agile.
Internet of Things Products that support receiving and transferring data over wireless networks without human intervention.
Logging and monitoring Products that support storing, searching, analyzing, and monitoring log data and events. And, products that support reviewing and managing the operational workflow and processes being logged.
Mobile Products with specific or special utility for users creatings things to be used on mobile devices.
Networking Products that support or augment the linking of computers so they can operate interactively.
Security Products that provide the protection of stored data from theft, leakage, and deletion.
Storage Products that support data to be created, read, updated, and deleted.

Adding search keywords

Add relevant keywords that enable your product to appear in search results when users search the catalog.

  1. Click Enter words, phrases, and other key search terms associated with the product.
  2. Enter one or more keywords for your product, and click Save.

Defining your product page

When users select your product from the catalog, they are directed to additional details, including a list of features and supporting media. These details are displayed on the About tab within your product page.

Providing a list of product features

Provide a list of features that highlights your product's attributes and benefits for users.

Use a descriptive title and 1-2 sentences for each feature. You want the information to be visually scannable for users.

Providing a detailed description about your product

Your detailed description explains the value of your product and what users gain by using it. The detailed description is displayed at the beginning of your product page in the catalog. You can expand on the short description for your catalog entry, but don't repeat the information you already provided.

Providing media

Provide links to high-quality images or videos to help illustrate what your product is, its value, and user benefits. The supported media types are images, videos in MP4 or WebM file format, and videos hosted on YouTube or Vimeo.

Some examples of effective media include an introductory walkthrough of your product, an explanation of what your product is and why users might want to use it, or a comparison of certain features.

Providing your documentation link

Your documentation link is used to direct users to your product's warranted documentation.