Skip to content

Commit d5b295e

Browse files
committed
docs: reword a few phrases on the existing documentation
1 parent c9bb4c5 commit d5b295e

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/modules/ROOT/pages/tutorials/deploy_eks.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Deployment on Amazon EKS
22

33
An example of a local deployment on Amazon EKS is provided https://github.com/camptocamp/devops-stack/tree/main/examples/eks[here]. Clone this repository and modify the files at your convenience.
4-
In the folder, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
4+
In the repository, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
55

66
* *`terraform.tf`* - declaration of the Terraform providers used in this project;
77
* *`locals.tf`* - local variables used by the DevOps Stack modules;
@@ -59,7 +59,7 @@ The `user_map` variable of that module allows you to create OIDC users used to a
5959

6060
=== Let's Encrypt SSL certificates
6161

62-
By default, to avoid rate-limiting your domain by Let's Encrypt, the example uses the `letsencrypt-staging` configuration of the cert-manager module to generate certificates using the Let's Encrypt staging environment which has an invalid CA certificate.
62+
By default, to avoid rate-limiting your domain by Let's Encrypt, the example uses the `letsencrypt-staging` configuration of the cert-manager module to generate certificates. This uses the Let's Encrypt staging environment which has an invalid CA certificate.
6363

6464
If you feel ready to test with production certificates, you can simply edit the `locals.tf` file and change the `cluster_issuer` variable to `letsencrypt-prod`.
6565

@@ -90,7 +90,7 @@ TIP: The xref:eks:ROOT:README.adoc[cluster module documentation] can help you kn
9090
+
9191
[source,terraform]
9292
----
93-
include::example$deploy_examples/sks/locals.tf[]
93+
include::example$deploy_examples/eks/locals.tf[]
9494
----
9595

9696
7. Finally, run `terraform apply` and accept the proposed changes to create the Kubernetes nodes on Amazon EKS and populate them with our services;
@@ -110,7 +110,7 @@ TIP: Take note of the local called `app_autosync`. If you set the condition of t
110110

111111
== Access the cluster and the DevOps Stack applications
112112

113-
To access your cluster you need to use the AWS CLI to recover a Kubeconfig you can use:
113+
To access your cluster, you need to use the AWS CLI to recover a Kubeconfig you can use:
114114

115115
[source,bash]
116116
----

docs/modules/ROOT/pages/tutorials/deploy_kind.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Deployment on KinD
22

33
An example of a local deployment on KinD is provided https://github.com/camptocamp/devops-stack/tree/main/examples/kind[here]. Clone this repository and modify the files at your convenience.
4-
In the folder, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
4+
In the repository, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
55

66
* *`terraform.tf`* - declaration of the Terraform providers used in this project as well as their configuration;
77
* *`locals.tf`* - local variables used by the DevOps Stack modules;

docs/modules/ROOT/pages/tutorials/deploy_sks.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Deployment on Exoscale SKS
22

33
An example of a local deployment on Exoscale SKS is provided https://github.com/camptocamp/devops-stack/tree/main/examples/sks[here]. Clone this repository and modify the files at your convenience.
4-
In the folder, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
4+
In the repository, as in a standard https://developer.hashicorp.com/terraform/tutorials/modules/module#what-is-a-terraform-module[Terraform module], you will find the following files:
55

66
* *`terraform.tf`* - declaration of the Terraform providers used in this project as well as their configuration;
77
* *`locals.tf`* - local variables used by the DevOps Stack modules;
@@ -101,7 +101,7 @@ TIP: If you do not provide a value for the `user_map` variable, the module will
101101

102102
=== Let's Encrypt SSL certificates
103103

104-
By default, to avoid rate-limiting your domain by Let's Encrypt, the example uses the `letsencrypt-staging` configuration of the cert-manager module to generate certificates using the Let's Encrypt staging environment which has an invalid CA certificate.
104+
By default, to avoid rate-limiting your domain by Let's Encrypt, the example uses the `letsencrypt-staging` configuration of the cert-manager module to generate certificates. This uses the Let's Encrypt staging environment which has an invalid CA certificate.
105105

106106
If you feel ready to test with production certificates, you can simply edit the `locals.tf` file and change the `cluster_issuer` variable to `letsencrypt-prod`.
107107

0 commit comments

Comments
 (0)