Document the fact that entity fragments exists #1115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request has been linked to Shortcut Story #16256: Document the fact that entity fragments exists. |
|
I sent Irma a loom with some thoughts |
Xantier
reviewed
Sep 11, 2023
Xantier
reviewed
Sep 11, 2023
Xantier
reviewed
Sep 11, 2023
Xantier
reviewed
Sep 11, 2023
dtuite
requested changes
Sep 13, 2023
| description: An introduction about decorating components. | ||
| --- | ||
|
|
||
| Components within the software catalog are structured around [metadata YAML files](https://backstage.io/docs/features/software-catalog/descriptor-format/) alongside the code, which are then collected and presented in Backstage for visualization. The source of truth for the components are mentioned YAML files, stored in source control such as GitHub, GitHub Enterprise, GitLab, Bitbucket, and others. |
There was a problem hiding this comment.
Suggested change
| Components within the software catalog are structured around [metadata YAML files](https://backstage.io/docs/features/software-catalog/descriptor-format/) alongside the code, which are then collected and presented in Backstage for visualization. The source of truth for the components are mentioned YAML files, stored in source control such as GitHub, GitHub Enterprise, GitLab, Bitbucket, and others. | |
| Decorators are an easy way to add links and annotations to Entities, without editing the YAML file that the Entity originates from. | |
| Decorators are stored inside Roadie and available via the API. |
|
|
||
| Components within the software catalog are structured around [metadata YAML files](https://backstage.io/docs/features/software-catalog/descriptor-format/) alongside the code, which are then collected and presented in Backstage for visualization. The source of truth for the components are mentioned YAML files, stored in source control such as GitHub, GitHub Enterprise, GitLab, Bitbucket, and others. | ||
|
|
||
| Because the process of adding components to the catalog can be achieved through manual registration, creating new components within Backstage, or integrating with an external source, the catalog may often comprise components with different sources of data. Consequently, modifying these components can be challenging, as it involves making changes in multiple locations. |
There was a problem hiding this comment.
Suggested change
| Because the process of adding components to the catalog can be achieved through manual registration, creating new components within Backstage, or integrating with an external source, the catalog may often comprise components with different sources of data. Consequently, modifying these components can be challenging, as it involves making changes in multiple locations. |
We don't need to explain why the feature exists in technical documentation.
|
|
||
| Because the process of adding components to the catalog can be achieved through manual registration, creating new components within Backstage, or integrating with an external source, the catalog may often comprise components with different sources of data. Consequently, modifying these components can be challenging, as it involves making changes in multiple locations. | ||
|
|
||
| Idea behind component decorator is to provide an easy way to modify components in one place, through Backstage, and enhance usability for components used accross organization. |
There was a problem hiding this comment.
Suggested change
| Idea behind component decorator is to provide an easy way to modify components in one place, through Backstage, and enhance usability for components used accross organization. |
I removed all additional stuff, as you requested @dtuite |
|
Kudos, SonarCloud Quality Gate passed!
|
dtuite
approved these changes
Sep 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://deploy-preview-1115--roadie.netlify.app/docs/details/decorating-components/