diff --git a/docs/common/entity-dependson.md b/docs/common/entity-dependson.md index 6976f41e1..b25dbe12e 100644 --- a/docs/common/entity-dependson.md +++ b/docs/common/entity-dependson.md @@ -1 +1,3 @@ + + An array of [entity references](https://backstage.io/docs/features/software-catalog/references#string-references) to the Components and Resources that this entity depends on, e.g. `dependsOn: [component:developer-portal-backend]`. There is no requirement for these entities to be created within the same location; Existing entities can be listed in the catalog. diff --git a/docs/common/entity-envelope.md b/docs/common/entity-envelope.md index da479211e..f7a397059 100644 --- a/docs/common/entity-envelope.md +++ b/docs/common/entity-envelope.md @@ -1,3 +1,5 @@ + + # `apiVersion` [Required] The `apiVersion` is the version of specification format for that particular entity that the specification is made against. The version is used for being able to evolve the format and to distinguish them from other types of object that share the same type of structure - e.g. Kubernetes object manifests. diff --git a/docs/common/entity-owner.md b/docs/common/entity-owner.md index 1c7e4d8d3..aa18a3f45 100644 --- a/docs/common/entity-owner.md +++ b/docs/common/entity-owner.md @@ -1,3 +1,5 @@ + + An [entity reference](https://backstage.io/docs/features/software-catalog/references#string-references) to the owner of the entity, e.g. `owner: user:enu43627`. Users and Groups are automatically populated, and can listed in the catalog by filtering by `Kind` of `User` or `Group` respectively. The owner of an entity is the `group` or `user` that bears ultimate responsibility for the entity, and has the authority and capability to develop and maintain it. They will be the point of contact if something goes wrong, or if features are to be requested. The main purpose of this field is for display purposes in Backstage, so that people looking at catalog items can get an understanding of to whom this entity belongs. It is not to be used by automated processes to for example assign authorization in runtime systems. There may be others that also develop or otherwise touch the entity, but there will always be one ultimate owner. diff --git a/docs/common/entity-system.md b/docs/common/entity-system.md index 51ab5ac59..0cfb633bc 100644 --- a/docs/common/entity-system.md +++ b/docs/common/entity-system.md @@ -1 +1,3 @@ + + An [entity reference](https://backstage.io/docs/features/software-catalog/references#string-references) to the [System](../explanations/system.md) that the entity belongs to, e.g. `developer-portal`. There is no requirement for this System to be created within the same location; Existing Systems can be listed in the catalog by filtering by `Kind` of `System`.