diff --git a/.vale.ini b/.vale.ini index 4ff9c184e..0513976ce 100644 --- a/.vale.ini +++ b/.vale.ini @@ -17,6 +17,9 @@ BasedOnStyles = alex, Vale, Microsoft, write-good # Ignore code blocks in Starlight's TabItems. BlockIgnores = (?s)(.*?```.*?```.*?) +# Ignore filesnames and director names in tree visualizations. +BlockIgnores = (?s)(.*?) + # Too harsh. The `write-good.Passive` check already covers many cases. write-good.E-Prime = NO diff --git a/docs/src/content/docs/nativelink-cloud/Bazel.mdx b/docs/src/content/docs/nativelink-cloud/Bazel.mdx deleted file mode 100644 index 0614add93..000000000 --- a/docs/src/content/docs/nativelink-cloud/Bazel.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Bazel Cloud Quickstart" -description: "Connect your Bazel setup to NativeLink Cloud" -pagefind: true ---- - -To connect NativeLink to your Bazel project, just add the code below to your `.bazelrc` file. If you can't find a `.bazelrc` file - create one in the same directory as your Bazel `WORKSPACE` or `MODULE.bazel` file. - -:::note - -Fill in the `CLAIM_CAS_URL`, `CLAIM_BES_URL` and `API_KEY` from [NativeLink Cloud](https://app.nativelink.com) - -::: - -1. **Configure your `.bazelrc`** - - Copy the following lines into your `.bazelrc`: - ``` - build --remote_cache=[CLAIM_CAS_URL] - build --remote_header=x-nativelink-api-key=[API_KEY] - build --remote_timeout=600 - build --bes_backend=[CLAIM_BES_URL] - build --bes_header=x-nativelink-api-key=[API_KEY] - build --remote_timeout=600 - ``` - -2. **Validate Connection** - - Once you've added those lines to your `.bazelrc`, run a Bazel build. - - You will see remote cache utilization on the [Dashboard](https://app.nativelink.com) page if your `.bazelrc` is configured correctly. diff --git a/docs/src/content/docs/nativelink-cloud/Pants.mdx b/docs/src/content/docs/nativelink-cloud/Pants.mdx deleted file mode 100644 index 937a75b7b..000000000 --- a/docs/src/content/docs/nativelink-cloud/Pants.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Configuration examples" -description: "NativeLink configuration guide" -pagefind: true ---- - -To connect NativeLink to your Pantsbuild project, just add the code below to your `pants.toml` file. If you can't find a `pants.toml` file - create one in the root directory of your Pantsbuild project. - -:::note - -Fill in the `REMOTE_STORE_ADDRESS` and `API_KEY` from the [NativeLink Cloud](https://app.nativelink.com) - -::: - -1. **Configure your `pants.toml`** - - Copy the following lines into your `pants.toml`: - ``` - [GLOBAL] - remote_cache_read = true - remote_cache_write = true - remote_store_address = "[REMOTE_STORE_ADDRESS]" - - [GLOBAL.remote_store_headers] - x-nativelink-api-key = "[API_KEY]" - ``` - -2. **Validate Connection** - - Once you've added those lines to your `pants.toml`, run the following command to execute a build: - ``` - pants --no-pantsd --level=trace --no-local-cache test :: - ``` - - You will see remote cache utilization on the [Dashboard](https://app.nativelink.com) page if your `pants.toml` is configured correctly. diff --git a/docs/src/content/docs/nativelink-cloud/bazel.mdx b/docs/src/content/docs/nativelink-cloud/bazel.mdx new file mode 100644 index 000000000..472c6258e --- /dev/null +++ b/docs/src/content/docs/nativelink-cloud/bazel.mdx @@ -0,0 +1,44 @@ +--- +title: "Bazel Cloud Quickstart" +description: "Connect your Bazel project to NativeLink Cloud" +pagefind: true +--- + +This guide shows how to connect your [Bazel](https://bazel.build/) project to +[NativeLink Cloud](https://app.nativelink.com). + +import { Steps } from "@astrojs/starlight/components"; +import { FileTree } from "@astrojs/starlight/components"; + + + +1. If you can't find a `.bazelrc` file create one in your project root: + + + - project/ + - WORKSPACE.bazel + - MODULE.bazel + - BUILD.bazel + - **.bazelrc** + + +2. Copy the following lines into your `.bazelrc`: + + ```bash + # .bazelrc + build --remote_cache=[CLAIM_CAS_URL] + build --remote_header=x-nativelink-api-key=[API_KEY] + build --remote_timeout=600 + build --bes_backend=[CLAIM_BES_URL] + build --bes_header=x-nativelink-api-key=[API_KEY] + build --remote_timeout=600 + ``` + + :::note + Fill in the `CLAIM_CAS_URL`, `CLAIM_BES_URL` and `API_KEY` from [NativeLink Cloud](https://app.nativelink.com). + ::: + +3. Run a Bazel build and you'll see remote cache use on the + [Dashboard](https://app.nativelink.com) page. + + diff --git a/docs/src/content/docs/nativelink-cloud/pants.mdx b/docs/src/content/docs/nativelink-cloud/pants.mdx new file mode 100644 index 000000000..f3916221e --- /dev/null +++ b/docs/src/content/docs/nativelink-cloud/pants.mdx @@ -0,0 +1,51 @@ +--- +title: "Pants Cloud Quickstart" +description: "Connect your Pants project to NativeLink Cloud" +pagefind: true +--- + +This guide shows how to connect your [Pantsbuild](https://www.pantsbuild.org/) +project to [NativeLink Cloud](https://app.nativelink.com). + +import { Steps } from "@astrojs/starlight/components"; +import { FileTree } from "@astrojs/starlight/components"; + + + +1. If you can't find a `pants.toml` file, create one in the root directory of + your Pantsbuild project: + + + - project/ + - get-pants.sh + - BUILD + - **pants.toml** + + +2. Copy the following lines into your `pants.toml`: + + ```toml + # pants.toml + [GLOBAL] + remote_cache_read = true + remote_cache_write = true + remote_store_address = "[REMOTE_STORE_ADDRESS]" + + [GLOBAL.remote_store_headers] + x-nativelink-api-key = "[API_KEY]" + ``` + + :::note + Fill in the `REMOTE_STORE_ADDRESS` and `API_KEY` from the [NativeLink Cloud](https://app.nativelink.com). + ::: + +3. Run a pants build with the following flags: + + ```bash + pants --no-pantsd --level=trace --no-local-cache test :: + ``` + +4. You'll see remote cache use on the [Dashboard](https://app.nativelink.com) + page. + +