Listing best practices
The following are best practices and suggestions for creating the optimal listing for your product in the Red Hat Ecosystem Catalog.
The product name is prominently displayed not only in your listing details but also in search results and in “featured” or “popular” collections. In most cases, your product name, company name, and product logo will all be displayed together to enable optimal brand recognition. Along with your own brand standards and policies, you should consider the following suggestions:
- Use title case
- Ensure that a customer can identify your product by the name, alone
- Don’t include your company name or brand unless it’s part of the product (since both the company and product logo will also be displayed)
- Don’t include descriptive data about your product
- Don't include the version in the product name
The product description is displayed both in your listing details and in search results, the latter of which may only show the first few sentences. As users scan search results, the product description is often a primary trigger for whether they decide to “double-click” and view more about your product. Currently, html and/or markdown is supported to enable you to include basic styling and hyperlinks. Suggestions for a good product description:
- Avoid unnecessary capitalization and punctuation
- Limit use of styling (e.g. bold, italic) as this can make it harder to read
- Include up to three of the primary features and benefits of your product
You are encouraged to include links to documentation, support policies and resources, and other references beneficial to customers. Currently, partners are required to include at least three linked resources, and one of these resources must be categorized as documentation. We encourage you to include:
- At least one link to your product’s documentation
- A link to learn more about your product
For some listings such as software, you can select up to three categories for your product. These categories are used to drive our discovery engine. However, you should only choose categories that are relevant to your product, as users will be frustrated if they find your product listed in categories which don’t don’t make sense to them. In addition, listing in multiple categories might signal to our discovery engine that your product is not as relevant in one of the categories as another company’s product that is only listed in that category. In most cases, only one category is needed.