Skip to content

Commit 65ba46c

Browse files
committed
Install: Implement suggestions by CodeRabbit
1 parent c06f322 commit 65ba46c

File tree

9 files changed

+20
-12
lines changed

9 files changed

+20
-12
lines changed

docs/install/cloud/aws/aws-terraform-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Deploy using Terraform
44

5-
In {ref}`ec2_setup`, we elaborated on how to leverage EC2's functionality to set
5+
In {ref}`ec2-setup`, we elaborated on how to leverage EC2's functionality to set
66
up a CrateDB cluster. Here, we will explore how to automate this kind of setup.
77

88
[Terraform] is an infrastructure as code tool, often used as an abstraction

docs/install/cloud/aws/s3-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ instances.
2525
2626
### Authentication
2727
28-
It is recommended to restrict the permissions of CrateDB on the S3 to only the
29-
required extend. First, an IAM role is required. This [AWS guide] gives a
28+
It is recommended to restrict the permissions of CrateDB on S3 to only the
29+
required extent. First, an IAM role is required. This [AWS guide] gives a
3030
short description of how to create a policy offer using the CLI or the AWS
3131
management console. Further, access of the snapshot to the S3 bucket needs to
3232
be restricted. An example policy file granting anybody access to a bucket

docs/install/cloud/azure/terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Deploy using Terraform
44

5-
In {ref}`azure_vm_setup`, we elaborated on how to leverage Azure's functionality to
5+
In {ref}`azure-vm-setup`, we elaborated on how to leverage Azure's functionality to
66
set up a CrateDB cluster. Here, we will explore how to automate this kind of
77
setup.
88

docs/install/cloud/azure/vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ VM based on the 'Windows Server 2012 R2 Datacenter' image.
149149
*Note that these instructions should be followed on each VM in your cluster.*
150150

151151
To install CrateDB on Windows Server, you will need a [Java JDK installed].
152-
Ensure that the `JAVA*HOME` environment variable is set.
152+
Ensure that the `JAVA_HOME` environment variable is set.
153153

154154
```{image} /_assets/img/install/cloud/azure-envvar.png
155155
:alt: Environment Variables

docs/install/container/docker.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ The official [CrateDB Docker image].
2222

2323
## Quick start
2424

25+
(container-create-cluster)=
26+
2527
### Creating a cluster
2628

2729
To get started with CrateDB and Docker, you will create a three-node cluster
@@ -55,7 +57,7 @@ container `crate03` will run cluster node `crate03`.
5557

5658
You can then create your first CrateDB container and node, like this:
5759

58-
```
60+
```shell
5961
sh$ docker run --rm -d \
6062
--name=crate01 \
6163
--net=crate \
@@ -79,7 +81,7 @@ Breaking the command down:
7981
{ref}`docker-compose` as reference).
8082
- Puts the container into the `crate` network and maps port `4201` on your
8183
host machine to port `4200` on the container (admin UI).
82-
- Defines the environment variable:ref:`CRATE_HEAP_SIZE <manual:conf-env-heap-size>`,
84+
- Defines the environment variable {ref}`CRATE_HEAP_SIZE <manual:conf-env-heap-size>`,
8385
which is used by CrateDB to allocate 1 GB for its heap memory.
8486
- Runs the command `crate` inside the container with parameters:
8587
: - `network.host`: The `_site_` value results in the binding of the
@@ -250,7 +252,8 @@ The CrateDB Shell, `crash`, is bundled with the Docker image.
250252

251253
If you wanted to run `crash` inside a user-defined network called `crate`
252254
and connect to three hosts named `crate01`, `crate02`, and `crate03`
253-
(i.e. the example covered in the [Creating a Cluster] section) you could run:
255+
(i.e. the example covered in the {ref}`container-create-cluster` section)
256+
you could run:
254257

255258
```shell
256259
$ docker run --rm -ti \

docs/install/container/kubernetes/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
CrateDB and Kubernetes are a great match.
77
:::
88

9-
CrateDB’s [horizontally scalable] `shared-nothing architecture` lends itself
9+
CrateDB’s [horizontally scalable] [shared-nothing architecture] lends itself
1010
well to [containerization].
1111

1212
[Kubernetes] is an open-source container orchestration system for the

docs/install/debian-ubuntu.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
(install-debian)=
55
(install-ubuntu)=
66

7-
# CrateDB on Debian, Ubuntu, and Derivates
7+
# CrateDB on Debian, Ubuntu, and derivatives
88

99
:::{div} sd-text-muted
1010
Install CrateDB [deb] packages using the [apt] package manager.
1111
:::
1212

13-
This installation method is suitable for Debian systems and derivates
13+
This installation method is suitable for Debian systems and derivatives
1414
like Ubuntu.
1515

1616
## Package repository

docs/install/redhat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
(install-redhat)=
44
(install-suse)=
55

6-
# CrateDB on Red Hat, SUSE, and Derivates
6+
# CrateDB on Red Hat, SUSE, and derivatives
77

88
:::{div} sd-text-muted
99
Install CrateDB [RPM] packages using the [DNF], [YUM], or [ZYpp] package managers.

docs/install/windows.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ us][contact us] so we can work with you on a solution.
1616
command-line shell or by using a GUI tool like [7-Zip]. We recommend
1717
using [PowerShell] when using terminal:
1818

19+
```powershell
20+
# Extract Zip archive
21+
Expand-Archive -Path .\crate-*.zip -DestinationPath .
22+
```
23+
1924
```doscon
2025
# Extract Zip archive
2126
unzip -o crate-*.zip

0 commit comments

Comments
 (0)