12eb5df469
- ✅ Activate powerpack recipe - ✅ Powerpack owners documentation - [x] Powerpack custom remote cache documentation - [x] Powerpack conformance documentation Infrastructure for powerpack docs - Adds the ability to generate API docs from ocean packages To generate API documentation for plugins in the ocean repository, run the `nx documentation` command with the `NX_OCEAN_RELATIVE_PATH` environment variable set to the relative path to your checked out copy of the ocean repo. ``` NX_OCEAN_RELATIVE_PATH=../ocean nx documentation ``` This will create generated API documentation in the `docs/external-generated` folder. This API will be merged into the normal `docs/generated` documentation when the docs site is built. Because there are two separate output folders, if someone runs `nx documentation` without the `NX_OCEAN_RELATIVE_PATH` environment variable, the ocean documentation will not be overwritten. The ocean documentation will only be updated or deleted when someone explicitly chooses to do so. --------- Co-authored-by: Juri Strumpflohner <juri.strumpflohner@gmail.com>
31 lines
955 B
JSON
31 lines
955 B
JSON
{
|
|
"name": "init",
|
|
"factory": "./src/generators/init/generator",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"$id": "Init",
|
|
"title": "",
|
|
"type": "object",
|
|
"properties": {
|
|
"region": {
|
|
"type": "string",
|
|
"description": "The AWS region the bucket is located in",
|
|
"x-prompt": "Which AWS region is the bucket located in?"
|
|
},
|
|
"bucket": {
|
|
"type": "string",
|
|
"description": "The the name of the S3 Bucket to store the Nx Cache in",
|
|
"x-prompt": "What is the name of the S3 Bucket to store the Nx Cache in?"
|
|
}
|
|
},
|
|
"required": ["region", "bucket"],
|
|
"presets": []
|
|
},
|
|
"description": "Initialize the S3 Cache",
|
|
"implementation": "/libs/nx-packages/powerpack-s3-cache/src/generators/init/generator.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/libs/nx-packages/powerpack-s3-cache/src/generators/init/schema.json",
|
|
"type": "generator"
|
|
}
|