chore(core): update documentation to change read to read-only

Cammisuli · Cammisuli · commit 0ef21d10d459 · 2025-01-20T13:52:59.000-05:00
diff --git a/docs/external-generated/packages/powerpack-azure-cache/documents/overview.md b/docs/external-generated/packages/powerpack-azure-cache/documents/overview.md
@@ -84,26 +84,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `contain
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "azure": {
     // ...
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "azure": {
     // ...
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```
diff --git a/docs/external-generated/packages/powerpack-gcs-cache/documents/overview.md b/docs/external-generated/packages/powerpack-gcs-cache/documents/overview.md
@@ -83,26 +83,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `bucket`
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "gcs": {
     // ...
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "gcs": {
     // ...
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```
diff --git a/docs/external-generated/packages/powerpack-s3-cache/documents/overview.md b/docs/external-generated/packages/powerpack-s3-cache/documents/overview.md
@@ -155,28 +155,28 @@ Below is an example on how to connect to MinIO:
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "s3": {
     "region": "us-east-1",
     "bucket": "my-bucket",
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "s3": {
     "region": "us-east-1",
     "bucket": "my-bucket",
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```
diff --git a/docs/shared/packages/powerpack-azure-cache/powerpack-azure-cache-plugin.md b/docs/shared/packages/powerpack-azure-cache/powerpack-azure-cache-plugin.md
@@ -84,26 +84,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `contain
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "azure": {
     // ...
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "azure": {
     // ...
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```
diff --git a/docs/shared/packages/powerpack-gcs-cache/powerpack-gcs-cache-plugin.md b/docs/shared/packages/powerpack-gcs-cache/powerpack-gcs-cache-plugin.md
@@ -83,26 +83,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `bucket`
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "gcs": {
     // ...
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "gcs": {
     // ...
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```
diff --git a/docs/shared/packages/powerpack-s3-cache/powerpack-s3-cache-plugin.md b/docs/shared/packages/powerpack-s3-cache/powerpack-s3-cache-plugin.md
@@ -155,28 +155,28 @@ Below is an example on how to connect to MinIO:
 
 # Cache Modes
 
-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
 
-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "s3": {
     "region": "us-east-1",
     "bucket": "my-bucket",
-    "localMode": "read"
+    "localMode": "read-only"
   }
 }
 ```
 
-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
 
 ```jsonc {% fileName="nx.json" %}
 {
   "s3": {
     "region": "us-east-1",
     "bucket": "my-bucket",
-    "ciMode": "read"
+    "ciMode": "read-only"
   }
 }
 ```

Original file line number	Diff line number	Diff line change
@@ -84,26 +84,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `contain
`84`	`84`
`85`	`85`	`# Cache Modes`
`86`	`86`
`87`		`-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
	`87`	`+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
`88`	`88`
`89`		-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
	`89`	+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
`90`	`90`
`91`	`91`	```jsonc {% fileName="nx.json" %}
`92`	`92`	`{`
`93`	`93`	`"azure": {`
`94`	`94`	`// ...`
`95`		`- "localMode": "read"`
	`95`	`+ "localMode": "read-only"`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`	```
`99`	`99`
`100`		-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
	`100`	+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
`101`	`101`
`102`	`102`	```jsonc {% fileName="nx.json" %}
`103`	`103`	`{`
`104`	`104`	`"azure": {`
`105`	`105`	`// ...`
`106`		`- "ciMode": "read"`
	`106`	`+ "ciMode": "read-only"`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`	```
Original file line number	Diff line number	Diff line change
@@ -83,26 +83,26 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `bucket`
`83`	`83`
`84`	`84`	`# Cache Modes`
`85`	`85`
`86`		`-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
	`86`	`+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
`87`	`87`
`88`		-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
	`88`	+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
`89`	`89`
`90`	`90`	```jsonc {% fileName="nx.json" %}
`91`	`91`	`{`
`92`	`92`	`"gcs": {`
`93`	`93`	`// ...`
`94`		`- "localMode": "read"`
	`94`	`+ "localMode": "read-only"`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`	```
`98`	`98`
`99`		-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
	`99`	+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
`100`	`100`
`101`	`101`	```jsonc {% fileName="nx.json" %}
`102`	`102`	`{`
`103`	`103`	`"gcs": {`
`104`	`104`	`// ...`
`105`		`- "ciMode": "read"`
	`105`	`+ "ciMode": "read-only"`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	```
Original file line number	Diff line number	Diff line change
`@@ -155,28 +155,28 @@ Below is an example on how to connect to MinIO:`
`155`	`155`
`156`	`156`	`# Cache Modes`
`157`	`157`
`158`		`-By default the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
	`158`	`+By default, the remote cache will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.`
`159`	`159`
`160`		-Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read` or `no-cache` in the `nx.json` file.
	`160`	+Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
`161`	`161`
`162`	`162`	```jsonc {% fileName="nx.json" %}
`163`	`163`	`{`
`164`	`164`	`"s3": {`
`165`	`165`	`"region": "us-east-1",`
`166`	`166`	`"bucket": "my-bucket",`
`167`		`- "localMode": "read"`
	`167`	`+ "localMode": "read-only"`
`168`	`168`	`}`
`169`	`169`	`}`
`170`	`170`	```
`171`	`171`
`172`		-The cache mode in CI can also be configured by setting `ciMode` to `read` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read` or `no-cache` in the CI environment.
	`172`	+The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
`173`	`173`
`174`	`174`	```jsonc {% fileName="nx.json" %}
`175`	`175`	`{`
`176`	`176`	`"s3": {`
`177`	`177`	`"region": "us-east-1",`
`178`	`178`	`"bucket": "my-bucket",`
`179`		`- "ciMode": "read"`
	`179`	`+ "ciMode": "read-only"`
`180`	`180`	`}`
`181`	`181`	`}`
`182`	`182`	```