paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

docs: intial package metadata docs

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2024-06-12 18:55:48 +02:00
parent 8f63f0a85b
commit e6e5ae2a91
3 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/tooling/package-metadata.md
+13
View File
@@ -0,0 +1,13 @@
---
id: package-metadata
title: Package Metadata
description: An inventory of well known package metadata fields in the Backstage ecosystem.
---
The `package.json` file is a JSON file that contains metadata about a JavaScript package, and in required for all package publish to NPM or a similar package registry. It is a [Node.js standard](https://nodejs.org/api/packages.html) that is expanded upon in the [NPM ecosystem](https://docs.npmjs.com/cli/v10/configuring-npm/package-json).
## Known Metadata Fields
This section documents the known `package.json` metadata fields that play a significant role in the Backstage ecosystem.
All [fields defined by NPM](https://docs.npmjs.com/cli/v10/configuring-npm/package-json) are inherited by the Backstage ecosystem. The list below only includes those standard fields for which additional information is available.