Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for Backstage #1

Open
wants to merge 2 commits into
base: cannot-edit-link
Choose a base branch
from
Open

Conversation

ChrisLivettEH
Copy link

Summary

To better maintain our repositories, we are adding/updating CODEOWNER files and catalog-info.yaml to all repositories, where necessary. This will allow Backstage to detect all repositories and collate information to be used by our engineers.

Required actions

The catalog-info.yaml file contains only basic information and can be expanded to better improve the usage of Backstage. Recommended additions include:

  • Adding circleci.com/project-slug in the annotations section to link to CircleCI (e.g. circleci.com/project-slug: github/Thinkei/bootstrap-wysihtml5-rails)
  • Adding sonarqube.org/project-key in the annotations section to link to SonarQube (e.g. sonarqube.org/project-key: bootstrap-wysihtml5-rails)
  • Adding datadoghq.com/dashboard-url in the annotations section to link to Datadog (e.g. datadoghq.com/dashboard-url: https://p.datadoghq.com/sb/abc-123-abc). Note: The dashboard must be set to have a publicly visible link for this to work, please use caution when doing this to avoid potentially disclosing any sensitive information. See Backstage Datadog Plugin for more information
  • If this repository exposes an API, declare the API as seen in form service catalog-info.yaml, by adding a providesApis link in the spec, and then referencing the OpenAPI docs in the kind: API spec. Note: Backstage uses Swagger, which does not currently support OpenAPI 3.1, so either the docs need to be OpenAPI 3.0 or lower, or wait until OpenAPI 3.1 support is released later this year

This Pull Request was automatically raised based on data believed to be correct. If this is incorrect, please modify the pull request to reflect who the owner should be or to make any amendments to the catalog file. Otherwise, please merge this pull request when convenient.

Thank you! If you have any questions or queries, please contact Chris Livett on Slack.

@ChrisLivettEH ChrisLivettEH requested a review from a team March 7, 2023 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant