beps/0009: add reference to the new package metadata section in docs

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-06-13 15:59:02 +02:00
parent f29347f1d7
commit 99e061c735
1 changed files with 1 additions and 1 deletions
@@ -85,7 +85,7 @@ To the furthest extent possible we will rely on established standards for `packa

 In the case of new fields we always define them to be part of the top-level `"backstage"` field. The assumption is that any field that we define will always be tied to the Backstage ecosystem, even in the case of general fields such as "lifecycle". The only exception to this is if we believe that a field is generic enough that it could genuinely become part of the broader NPM ecosystem.

-All fields must be documented in a new section of the "Tooling" documentation on backstage.io. This documentation should include a description of the field, what it is used for, and what the expected values are. The documentation must also mention whether the field is expected to be filled in manually, or if it will be generated by tooling. Changes to this documentation must be approved by the Backstage core maintainers, it is not owned by individual project area maintainers.
+All fields must be documented in a [new section](../../docs/tooling/package-metadata.md) of the "Tooling" documentation on backstage.io. This documentation should include a description of the field, what it is used for, and what the expected values are. The documentation must also mention whether the field is expected to be filled in manually, or if it will be generated by tooling. Changes to this documentation must be approved by the Backstage core maintainers, it is not owned by individual project area maintainers.

 ### Package Relationships