Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# 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: ```yaml - 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](https://github.com/vtex/dk-cicd-hub/blob/main/docs/pipelines/techdocs-v1.md) 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! Co-authored-by: dk-portal[bot] <134092483+dk-portal[bot]@users.noreply.github.com>
- Loading branch information