docs: intial package metadata docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -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.
|
||||
@@ -362,7 +362,8 @@
|
||||
"tooling/local-dev/linking-local-packages",
|
||||
"tooling/local-dev/debugging"
|
||||
]
|
||||
}
|
||||
},
|
||||
"tooling/package-metadata"
|
||||
],
|
||||
"Deployment": [
|
||||
"deployment/index",
|
||||
|
||||
@@ -180,6 +180,7 @@ nav:
|
||||
- Local Development:
|
||||
- Linking in Local Packages: 'tooling/local-dev/linking-local-packages.md'
|
||||
- Debugging Backstage: 'tooling/local-dev/debugging.md'
|
||||
- Package Metadata: 'tooling/package-metadata.md'
|
||||
- Deployment:
|
||||
- Deploying Backstage: 'deployment/index.md'
|
||||
- Scaling: 'deployment/scaling.md'
|
||||
|
||||
Reference in New Issue
Block a user