Skip to content

Commit cb6ef19

Browse files
committed
add alpha labels and update xrefs
1 parent ac0d992 commit cb6ef19

File tree

5 files changed

+19
-7
lines changed

5 files changed

+19
-7
lines changed

docs/reference/replicated-cli-config-file-reference.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# .replicated File Reference
1+
# .replicated File Reference (Alpha)
2+
3+
:::important
4+
The `.replicated` configuration file is Alpha and its functionality is subject to change. For access to this feature, reach out to your Replicated account representative.
5+
:::
26

37
This topic describes all supported fields in the `.replicated` configuration file. It also provides examples of `.replicated` configuration files.
48

docs/reference/replicated-cli-config-file.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Add a .replicated File
1+
# Add a .replicated File (Alpha)
2+
3+
:::important
4+
The `.replicated` configuration file is Alpha and its functionality is subject to change. For access to this feature, reach out to your Replicated account representative.
5+
:::
26

37
This topic describes the `.replicated` configuration file, including how to add a `.replicated` file and how the Replicated CLI uses this file to discover and process your application resources when linting and creating releases.
48

@@ -8,12 +12,16 @@ For a reference that describes the fields in the `.replicated` file, see [.repli
812

913
You can add a `.replicated` configuration file to set various preferences for the Replicated CLI, such as the application slug, the channel ID for promoting releases, paths to your application resources (including Helm charts, preflight specs, or Kubernetes manifests), and more. This file enables the [`replicated release create`](/reference/replicated-cli-release-create) and [`replicated release lint`](/reference/replicated-cli-release-lint) commands to automatically discover your application resources and preferences to help ensure consistent builds when managing releases from the Replicated CLI.
1014

11-
The Replicated CLI searches for `.replicated` or `.replicated.yaml` files starting from the current directory and walking up the directory tree. If no `.replicated` file is found, the Replicated CLI:
15+
When the `.replicated` configuration file Alpha feature is enabled for your account, the Replicated CLI searches for `.replicated` or `.replicated.yaml` files starting from the current directory and walking up the directory tree. If no `.replicated` file is found, then the Replicated CLI:
1216
- Automatically searches for Helm charts in the current directory
1317
- Auto-detects preflight specs (files with `kind: Preflight`)
1418
- Auto-detects support bundle specs (files with `kind: SupportBundle`)
1519
- Uses default linting configuration
1620

21+
## Prerequisite
22+
23+
For access to the `.replicated` configuration file Alpha feature, reach out to your Replicated account representative.
24+
1725
## About Using Multiple `.replicated` Files for Monorepos
1826

1927
The Replicated CLI supports both single-repository projects with one `.replicated` file at the root and monorepo projects with multiple `.replicated` files at different levels.

docs/reference/replicated-cli-installing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ replicated profile use company-b
110110
replicated app ls # Lists apps for company-b
111111
```
112112

113-
{/* UPDATE LINK For more information, see [replicated profile](/replicated-cli-profile). */}
113+
For more information, see [replicated profile](/reference/replicated-cli-profile).
114114

115115
### Set Environment Variables {#env-var}
116116

docs/vendor/releases-creating-cli.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Before you create a release using the Replicated CLI, complete the following pre
1212

1313
* Install the Replicated CLI. See [Install the Replicated CLI](/reference/replicated-cli-installing).
1414

15-
* Create a new application using the `replicated app create APP_NAME` command. You only need to do this procedure one time for each application that you want to deploy. See [`app create`](/reference/replicated-cli-app-create) in _Reference_.
15+
* If you do not yet have an application in the Replicated Platform, create a new application using the `replicated app create APP_NAME` command. See [`app create`](/reference/replicated-cli-app-create) in _Reference_.
1616

17-
* Add a `.replicated` configuration file to your project. See [Add a .replicated File](/reference/replicated-cli-config-file). Alternatively, set the `REPLICATED_APP` environment variable to the slug of the target application. See [Set Environment Variables](/reference/replicated-cli-installing#env-var) in _Installing the Replicated CLI_.
17+
* Set the `REPLICATED_APP` environment variable to the slug of the application. See [Set Environment Variables](/reference/replicated-cli-installing#env-var) in _Installing the Replicated CLI_.
1818

1919
## Create a Release From a Local Directory {#dir}
2020

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,7 @@ const sidebars = {
727727
},
728728
{
729729
type: 'category',
730-
label: 'Replicated CLI Configuration File',
730+
label: 'Replicated CLI Configuration File (Alpha)',
731731
items: [
732732
'reference/replicated-cli-config-file',
733733
'reference/replicated-cli-config-file-reference',

0 commit comments

Comments
 (0)