Service description field

Release notes

Problem to solve

As an Engineer on call, I want to quickly get up to speed on a service, including all the related information about it.

As a Release Manager, I want to learn about the non-codified processes around a service to be able to follow them.

Proposal

Provide the ability to add a description to a release. Show the description on the first page that loads when the service detail page is opened.

Show the same description across all the environments.

The description should support:

• markdown (especially lists and links)
• widgets
  • be able to add groupobservability widgets to provide real-time data about the service

Open questions:

• store the description in code or in a DB field?

Intended users

• Delaney (Development Team Lead)
• Rachel (Release Manager)
• Allison (Application Ops)
• Ingrid (Infrastructure Operator)

Feature Usage Metrics

• Ratio of services with a description
• Ratio of descriptions with at least one widget
• Number and type of widgets used per description

Does this feature require an audit event?

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.