#59 - Fix domain examples, cross-doc links.

edenlabllc · Feb 5, 2025 · a99cdaf · a99cdaf
1 parent e5458e2
commit a99cdaf
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/backward-compatibility.md b/docs/backward-compatibility.md
@@ -50,7 +50,7 @@ This change was driven by several **key factors**:
 
 ### Deprecated features
 
-For the [rmk config init](http://localhost:8000/rmk/commands/#init-i) command:
+For the [rmk config init](commands.md#init-i) command:
 
 - **--artifact-mode**, **--aws-reconfigure-artifact-license**: removed the flag along with the functionality, no longer
   needed.
@@ -68,7 +68,7 @@ For the [rmk config init](http://localhost:8000/rmk/commands/#init-i) command:
 - **--s3-charts-repo-region**: removed the flag, replaced with the private repository configuration
   via [Helmfile](https://helmfile.readthedocs.io/en/latest/#configuration).
 
-For the [rmk cluster](http://localhost:8000/rmk/commands/#cluster) command category:
+For the [rmk cluster](commands.md#cluster) command category:
 
 - **container-registry**: removed the command along with all flags.
 - **destroy**: removed the command along with all flags (Terraform is no longer in use).

diff --git a/docs/configuration/cluster-management/exported-environment-variables.md b/docs/configuration/cluster-management/exported-environment-variables.md
@@ -15,7 +15,7 @@ NAME="<project_name>-<project_branch>"
 
 # Root domain name for target applications in the cluster.
 # For example:
-# ROOT_DOMAIN=rmk-test-develop.example.com
+# ROOT_DOMAIN=rmk-test-develop.edenlab.dev
 ROOT_DOMAIN="<project_name>-<project_branch>.<domain>"
 
 # Path to the file containing the merged private SOPS Age keys.

diff --git a/docs/configuration/configuration-management/configuration-management.md b/docs/configuration/configuration-management/configuration-management.md
@@ -87,7 +87,7 @@ project:
   spec:
     environments:
       develop:
-        root-domain: 'test.example.com'
+        root-domain: test.example.com
 ```
 
 Then run the following command:

diff --git a/docs/configuration/project-management/preparation-of-project-repository.md b/docs/configuration/project-management/preparation-of-project-repository.md
@@ -32,7 +32,7 @@ specification described in [project.yaml](#projectyaml) file.
 Use the following command:
 
 ```shell
-rmk project generate --environment="develop.root-domain=localhost" \
+rmk project generate --environment="develop.root-domain=<custom_root_domain_name>" \
   --owner=gh_user --scope=<upstream_project_name> \
   --scope=<downstream_project_name> 
 ```
@@ -66,7 +66,7 @@ and contains the following main sections:
       # Required, list of available environments with specific root domain name (Git branches). 
       environments:
         - develop:
-            root-domain: localhost
+            root-domain: <custom_name>.example.com
         - production:
             root-domain: <custom_name>.example.com
         - staging: