Skip to content

Dark Kitchen Catalog Setup#102

Open
iagolaguna wants to merge 1 commit into
masterfrom
dk-portal-setup
Open

Dark Kitchen Catalog Setup#102
iagolaguna wants to merge 1 commit into
masterfrom
dk-portal-setup

Conversation

@iagolaguna
Copy link
Copy Markdown

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!

@iagolaguna iagolaguna requested a review from a team as a code owner May 8, 2026 20:02
Comment thread .vtex/catalog-info.yaml
kind: Component
metadata:
name: vtex.js
description: SDK JavaScript para acesso às APIs da VTEX (legado, jQuery-based).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: SDK JavaScript para acesso às APIs da VTEX (legado, jQuery-based).
description: JavaScript SDK for accessing VTEX APIs (legacy, jQuery-based).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants