Skip to main content

Service frontmatter config

Overview​

Services are just markdown files, with this comes the use of Content, MDX components and also front-matter.

Services group resources together, and teams and owners can be assigned services.

You can learn more about services in the guide.

Here is an example of a service.

---
id: payment-service
description: The Payment Service, leveraging AWS Lambda functions.
name: Payment Service
owners:
  - dboyne
  - paymentTeam
---

### What is this service?

The Payment Service is a sophisticated cloud-based architecture, primarily composed of a suite of AWS Lambda functions, each expertly designed to handle specific aspects of the payment processing lifecycle.

This modular approach ensures high scalability, reliability, and efficiency, making it ideal for businesses seeking to streamline their payment operations. The service covers a broad range of functionalities, from initiating and processing transactions to handling confirmations and sending payment-related notifications.

Required fields​

id​

A unique id of your service.

info

You will use this id in your resources when you link resources to services. Read the guide.

Example
---
id: payment-service
---

name​

A name for your service. This name will be rendered in the UI.

Example
---
name: Payment Service
---

Optional fields​

description​

Short summary of your service.

tip

Keep it short, remember you can add as much detail as you want in the markdown section of your service! Add images, videos anything. It's just markdown.

Example
---
description: The Payment Service, leveraging AWS Lambda functions
---

owners​

An array of users or teams ids that own the resource.

Example
---
owners:
  - dboyne
  - mSmith
  - my-awesome-team
---