Dark Kitchen Catalog Setup

[dk-portal]

Initial DK Catalog Setup

Overview

This pull request introduces the initial setup for the DK catalog. It includes the catalog-info.yaml file for integrating our services with the DK, facilitating better visibility and management of our software components.

Changes

• Added catalog-info.yaml with the necessary metadata for our VTEX services.
• Configured annotations for GitHub, Grafana, and TechDocs integration.
• Defined essential fields such as type, lifecycle, owner, system.

Purpose

The integration into DK software catalog aims to improve the discoverability, documentation, and management of our software components. It allows for a more centralized and organized view of our system architecture.

Requested Action

Review:

Please review the contents of the catalog-info.yaml for accuracy and completeness.

Tech Docs Pipeline Setup:

If this repository contains docs that you want shown at your Component/System page add the following Pipeline to your .vtex/deployment.(json|yaml) file:

- name: techdocs-v1
  parameters:
    entityReference: default/<component or system>/<your entity name> # add your entity type and name here
    sourceDir: ./
  when:
  - event: push
    source: branch
    regex: main # configure with your repository's default branch
  path:
  - "docs/*" # this will make sure this pipeline is triggered only when the `docs` directory is changes. If you use another directory to store your docs, change this.

Check the complete Pipeline documentation for more custom options.

Feedback:

Suggestions for additional metadata or modifications to existing fields.

Approval:

Once reviewed and agreed upon, approval for merge.

Impact

• Visibility: Enhanced visibility of our services within the organization.
• Documentation: Better linkage to our documentation and monitoring tools.
• Collaboration: Easier for teams to find and understand dependencies and relationships between services.

Additional Notes

• This is part of an ongoing effort to document and manage our software architecture more effectively.
• Further iterations may include additional annotations and refinements as our usage of DK evolves.

---

Thank you for contributing to improving our software infrastructure!

[vtex-io-docs-bot]

Beep boop 🤖

I noticed you didn't make any changes at the docs/ folder

• There's nothing new to document 🤔
• I'll do it later 😞

In order to keep track, I'll create an issue if you decide now is not a good time

• I just updated 🎉🎉

[vtex-io-ci-cd]

Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖

Please select which version do you want to release:

• Patch (backwards-compatible bug fixes)

• Minor (backwards-compatible functionality)

• Major (incompatible API changes)

And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.

• No thanks, I would rather do it manually 😞