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>
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# Activate Powerpack
|
|
|
|
Nx Powerpack unlocks features of Nx that are particularly useful for larger organizations. The features include the ability to:
|
|
|
|
- [Run language-agnostic conformance rules](/features/powerpack/conformance)
|
|
- [Define code ownership at the project level](/features/powerpack/owners)
|
|
- [Change the remote cache storage location](/features/powerpack/custom-caching)
|
|
|
|
Activating Powerpack is a two step process.
|
|
|
|
## 1. Purchase a License
|
|
|
|
You'll need to [purchase a license](https://nx.app/powerpack/purchase) online. The license cost depends on the
|
|
|
|
{% call-to-action title="Buy a Powerpack License" icon="nx" description="Unlock all the features of Nx" url="https://nx.app/powerpack/purchase" /%}
|
|
|
|
Once you've completed the purchase, you will receive a license key.
|
|
|
|
## 2. Register the License Key
|
|
|
|
{% tabs %}
|
|
{% tab label="Closed Source Repository" %}
|
|
|
|
To register the license key in your repository, run the `nx activate-powerpack` command.
|
|
|
|
```shell
|
|
nx activate-powerpack YOUR_LICENSE_KEY
|
|
```
|
|
|
|
The license will be saved in your repository and should be committed so that every developer has access to the Powerpack features.
|
|
|
|
{% /tab %}
|
|
{% tab label="Open Source Repository" %}
|
|
|
|
Register the license key as an environment variable that is not committed to the repository.
|
|
|
|
```{% fileName=".env" %}
|
|
NX_POWERPACK_LICENSE=YOUR_LICENSE_KEY
|
|
```
|
|
|
|
{% /tab %}
|
|
{% /tabs %}
|