Skip to content

Commit

Permalink
docs(core): powerpack plugin icons (#28180)
Browse files Browse the repository at this point in the history
- Add icons for powerpack plugins on /nx-api page
- Mention Powerpack requires Nx 19.8+
- Mention free OSS license in activate powerpack recipe
  • Loading branch information
isaacplmann authored Sep 27, 2024
1 parent 1a4959f commit 86a43de
Show file tree
Hide file tree
Showing 11 changed files with 44 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/shared/features/powerpack/conformance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% youtube src="https://youtu.be/6wg23sLveTQ" title="Nx Powerpack workspace conformance" /%}

The [`@nx/powerpack-conformance`](/nx-api/powerpack-conformance) plugin allows [Nx Powerpack](/powerpack) users to write and apply rules for your entire workspace that help with **consistency**, **maintainability**, **reliability** and **security**.
The [`@nx/powerpack-conformance`](/nx-api/powerpack-conformance) plugin allows [Nx Powerpack](/powerpack) users to write and apply rules for your entire workspace that help with **consistency**, **maintainability**, **reliability** and **security**. Powerpack is available for Nx version 19.8 and higher.

The conformance plugin allows you to **encode your own organization's standards** so that they can be enforced automatically. Conformance rules can also **complement linting tools** by enforcing that those tools are configured in the recommended way. The rules are written in TypeScript but can be **applied to any language in the codebase** or focus entirely on configuration files.

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/features/powerpack/custom-caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% youtube src="https://youtu.be/vRGAa5SuiTM" title="Nx Powerpack self-hosted cache storage" /%}

The recommended way to enable the [remote cache](/ci/features/remote-cache) is to use Nx Replay and have Nx Cloud share the task cache across your organization. For those organizations that are unable to use Nx Cloud, Nx offers official plugins that are enabled by [Nx Powerpack](/powerpack) to self-host the remote cache in a fast and secure manner. The recommended ways to host the remote cache are, in order of preference:
The recommended way to enable the [remote cache](/ci/features/remote-cache) is to use Nx Replay and have Nx Cloud share the task cache across your organization. For those organizations that are unable to use Nx Cloud, Nx offers official plugins that are enabled by [Nx Powerpack](/powerpack) to self-host the remote cache in a fast and secure manner. Powerpack is available for Nx version 19.8 and higher. The recommended ways to host the remote cache are, in order of preference:

1. [Nx Replay](/ci/features/remote-cache): Cache is hosted on Nx Cloud servers or on-premise with an [Nx Enterprise](/enterprise) contract
2. [@nx/powerpack-s3-cache](/nx-api/powerpack-s3-cache): Cache is on a self-hosted Amazon S3 bucket
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/features/powerpack/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Powerpack Features

Nx PowerPack is a suite of paid extensions for the Nx CLI specifically designed for enterprises.
Nx PowerPack is a suite of paid extensions for the Nx CLI specifically designed for enterprises. Powerpack is available for Nx version 19.8 and higher.

The following features are available after you [activate a Powerpack license](/recipes/installation/activate-powerpack):

Expand Down
2 changes: 1 addition & 1 deletion docs/shared/features/powerpack/owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{% youtube src="https://youtu.be/mor6urvw-L0" title="Nx Powerpack Codeowners" /%}

This plugin provides the ability to configure and maintain code owners for projects in an Nx workspace.
This plugin provides [Nx Powerpack](/powerpack) users the ability to configure and maintain code owners for projects in an Nx workspace. Powerpack is available for Nx version 19.8 and higher.

The atomic unit of code in an Nx workspace is a project. Tasks, module boundaries and the Nx graph all train us to conceptualize the workspace as a collection of projects. The CODEOWNERS file, however, requires you to switch from a project mental model to a more low-level definition based on the folder structure of your workspace. The `@nx/powerpack-owners` plugin enables you to stay in the mental model that your workspace is a collection of projects as you define the ownership rules for your workspace. Nx will take care of compiling the project ownership rules into file-based ownership rules that [GitHub](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/set-up-and-use-code-owners/) or [GitLab](https://docs.gitlab.com/ee/user/project/codeowners/) can understand in the CODEOWNERS file.

Expand Down
4 changes: 2 additions & 2 deletions docs/shared/recipes/installation/activate-powerpack.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Activate Powerpack

Nx Powerpack unlocks features of Nx that are particularly useful for larger organizations. The features include the ability to:
Nx Powerpack unlocks features of Nx that are particularly useful for larger organizations. Powerpack is available for Nx version 19.8 and higher. The features include the ability to:

- [Run language-agnostic conformance rules](/features/powerpack/conformance)
- [Define code ownership at the project level](/features/powerpack/owners)
Expand All @@ -10,7 +10,7 @@ Activating Powerpack is a two step process.

## 1. Purchase a License

You'll need to [purchase a license](https://cloud.nx.app/powerpack/purchase) online. The license cost depends on the
You'll need to [purchase a license](https://cloud.nx.app/powerpack/purchase) online. The license is a seat-based license. If you have an open-source repository, reach out to [[email protected]](mailto:[email protected]) for a free license.

{% call-to-action title="Buy a Powerpack License" icon="nx" description="Unlock all the features of Nx" url="https://cloud.nx.app/powerpack/purchase" /%}

Expand Down
5 changes: 5 additions & 0 deletions nx-dev/nx-dev/public/images/icons/powerpack-conformance.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions nx-dev/nx-dev/public/images/icons/powerpack-license.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions nx-dev/nx-dev/public/images/icons/powerpack-owners.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions nx-dev/nx-dev/public/images/icons/powerpack-s3-cache.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions nx-dev/ui-references/src/lib/icons-map.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ export const iconsMap: Record<string, string> = {
nx: '/images/icons/nx.svg',
playwright: '/images/icons/playwright.svg',
plugin: '/images/icons/nx.svg',
'powerpack-conformance': '/images/icons/powerpack-conformance.svg',
'powerpack-license': '/images/icons/powerpack-license.svg',
'powerpack-owners': '/images/icons/powerpack-owners.svg',
'powerpack-s3-cache': '/images/icons/powerpack-s3-cache.svg',
'powerpack-shared-fs-cache': '/images/icons/powerpack-shared-fs-cache.svg',
react: '/images/icons/react.svg',
'react-native': '/images/icons/react.svg',
remix: '/images/icons/remix.svg',
Expand Down

0 comments on commit 86a43de

Please sign in to comment.