From 86a43de09acb1f2742acfdb8a5325ef4d8cc8fbc Mon Sep 17 00:00:00 2001 From: Isaac Mann Date: Fri, 27 Sep 2024 14:39:13 -0400 Subject: [PATCH] docs(core): powerpack plugin icons (#28180) - Add icons for powerpack plugins on /nx-api page - Mention Powerpack requires Nx 19.8+ - Mention free OSS license in activate powerpack recipe --- docs/shared/features/powerpack/conformance.md | 2 +- docs/shared/features/powerpack/custom-caching.md | 2 +- docs/shared/features/powerpack/index.md | 2 +- docs/shared/features/powerpack/owners.md | 2 +- docs/shared/recipes/installation/activate-powerpack.md | 4 ++-- .../public/images/icons/powerpack-conformance.svg | 5 +++++ .../nx-dev/public/images/icons/powerpack-license.svg | 6 ++++++ nx-dev/nx-dev/public/images/icons/powerpack-owners.svg | 6 ++++++ .../nx-dev/public/images/icons/powerpack-s3-cache.svg | 10 ++++++++++ .../public/images/icons/powerpack-shared-fs-cache.svg | 6 ++++++ nx-dev/ui-references/src/lib/icons-map.ts | 5 +++++ 11 files changed, 44 insertions(+), 6 deletions(-) create mode 100644 nx-dev/nx-dev/public/images/icons/powerpack-conformance.svg create mode 100644 nx-dev/nx-dev/public/images/icons/powerpack-license.svg create mode 100644 nx-dev/nx-dev/public/images/icons/powerpack-owners.svg create mode 100644 nx-dev/nx-dev/public/images/icons/powerpack-s3-cache.svg create mode 100644 nx-dev/nx-dev/public/images/icons/powerpack-shared-fs-cache.svg diff --git a/docs/shared/features/powerpack/conformance.md b/docs/shared/features/powerpack/conformance.md index df8bce1f45ace..9be4b4b2e083b 100644 --- a/docs/shared/features/powerpack/conformance.md +++ b/docs/shared/features/powerpack/conformance.md @@ -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. diff --git a/docs/shared/features/powerpack/custom-caching.md b/docs/shared/features/powerpack/custom-caching.md index 3f3d19e78f1ac..578979059d755 100644 --- a/docs/shared/features/powerpack/custom-caching.md +++ b/docs/shared/features/powerpack/custom-caching.md @@ -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 diff --git a/docs/shared/features/powerpack/index.md b/docs/shared/features/powerpack/index.md index 8b066fe01f113..67f3f7591d2ea 100644 --- a/docs/shared/features/powerpack/index.md +++ b/docs/shared/features/powerpack/index.md @@ -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): diff --git a/docs/shared/features/powerpack/owners.md b/docs/shared/features/powerpack/owners.md index f5975c9f06ccc..dcdd4511687d5 100644 --- a/docs/shared/features/powerpack/owners.md +++ b/docs/shared/features/powerpack/owners.md @@ -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. diff --git a/docs/shared/recipes/installation/activate-powerpack.md b/docs/shared/recipes/installation/activate-powerpack.md index 99f0ad5160f3d..58d8fd36ee780 100644 --- a/docs/shared/recipes/installation/activate-powerpack.md +++ b/docs/shared/recipes/installation/activate-powerpack.md @@ -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) @@ -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 [powerpack-support@nrwl.io](mailto:powerpack-support@nrwl.io) 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" /%} diff --git a/nx-dev/nx-dev/public/images/icons/powerpack-conformance.svg b/nx-dev/nx-dev/public/images/icons/powerpack-conformance.svg new file mode 100644 index 0000000000000..aa79b18f131eb --- /dev/null +++ b/nx-dev/nx-dev/public/images/icons/powerpack-conformance.svg @@ -0,0 +1,5 @@ + \ No newline at end of file diff --git a/nx-dev/nx-dev/public/images/icons/powerpack-license.svg b/nx-dev/nx-dev/public/images/icons/powerpack-license.svg new file mode 100644 index 0000000000000..189f4c7761b3a --- /dev/null +++ b/nx-dev/nx-dev/public/images/icons/powerpack-license.svg @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/nx-dev/nx-dev/public/images/icons/powerpack-owners.svg b/nx-dev/nx-dev/public/images/icons/powerpack-owners.svg new file mode 100644 index 0000000000000..b5343574b50e1 --- /dev/null +++ b/nx-dev/nx-dev/public/images/icons/powerpack-owners.svg @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/nx-dev/nx-dev/public/images/icons/powerpack-s3-cache.svg b/nx-dev/nx-dev/public/images/icons/powerpack-s3-cache.svg new file mode 100644 index 0000000000000..bcc051491f780 --- /dev/null +++ b/nx-dev/nx-dev/public/images/icons/powerpack-s3-cache.svg @@ -0,0 +1,10 @@ + + AWS + + \ No newline at end of file diff --git a/nx-dev/nx-dev/public/images/icons/powerpack-shared-fs-cache.svg b/nx-dev/nx-dev/public/images/icons/powerpack-shared-fs-cache.svg new file mode 100644 index 0000000000000..91f2af91ed07e --- /dev/null +++ b/nx-dev/nx-dev/public/images/icons/powerpack-shared-fs-cache.svg @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/nx-dev/ui-references/src/lib/icons-map.ts b/nx-dev/ui-references/src/lib/icons-map.ts index 6536a5870720a..3c33c74331063 100644 --- a/nx-dev/ui-references/src/lib/icons-map.ts +++ b/nx-dev/ui-references/src/lib/icons-map.ts @@ -21,6 +21,11 @@ export const iconsMap: Record = { 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',