Skip to content

Commit ef5ce24

Browse files
committed
fix: set terminology according to lint settings
1 parent 4121baa commit ef5ce24

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository currently contains our WIP state for the infrastructure code.
44

55
This is a replacement for the old [puppet repository](https://github.com/freifunk-berlin/puppet).
66

7-
Keep in mind that we also use ansible to configure the BerlinBackBone, this is done in the [bbb-configs repository](https://github.com/freifunk-berlin/bbb-configs).
7+
Keep in mind that we also use Ansible to configure the BerlinBackBone, this is done in the [bbb-configs repository](https://github.com/freifunk-berlin/bbb-configs).
88

99
The code is, where necessary, quite debian centric since that's the distribution we use in our infrastructure.
1010

@@ -22,18 +22,17 @@ This repository currently manages these services:
2222

2323
## Requirements // How to use
2424

25-
- check out this repo and `cd` into it
25+
- check out this repository and `cd` into it
2626
- create a venv and activate it: `python -m venv venv && source venv/bin/activate`
2727
- install the python dependencies: `pip install -r requirements.txt`
2828
- install the external roles: `ansible-galaxy install -r requirements.yml`
2929
- install the external collections: `ansible-galaxy collection install -r requirements.yml`
3030
- Save the secret encryption password for ansible-vault under `./.vaultpass`
3131
- For alternative methods look here: <https://docs.ansible.com/ansible/latest/user_guide/vault.html>
3232

33-
3433
## Structure
3534

36-
We follow an adapted version of the [ansible alternative layout](https://docs.ansible.com/ansible/2.8/user_guide/playbooks_best_practices.html#alternative-directory-layout).
35+
We follow an adapted version of the [Ansible alternative layout](https://docs.ansible.com/ansible/2.8/user_guide/playbooks_best_practices.html#alternative-directory-layout).
3736
Where we put the inventory in an extra directory, but don't use different directories for the stages (Since we don't have any).
3837
Also, the roles are divided into 2 directories, one for external ones, and one for our internal ones.
3938

Tutorials.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tutorials
22

3-
In this file, you will find some tutorials describing common workflows for using this repo. We generally assume, that all Hosts, that will be managed by this ansible repository run a recent minimal stable Debian version (at time of writing: Debian 11). Our custom roles do mostly rely on this.
3+
In this file, you will find some tutorials describing common workflows for using this repository. We generally assume, that all Hosts, that will be managed by this Ansible repository run a recent minimal stable Debian version (at time of writing: Debian 11). Our custom roles do mostly rely on this.
44

55
## Prerequisites on to-be-provisioned machine
66

@@ -13,7 +13,7 @@ In this file, you will find some tutorials describing common workflows for using
1313

1414
- this repository cloned
1515
- python3 installation
16-
- ansible installation (`pip install -r requirements.txt`)
16+
- Ansible installation (`pip install -r requirements.txt`)
1717

1818
We use ansible-vaultpass for storing secrets encrypted in this repository. For provisioning machines with this repository, you need a password in the `.vaultpass` files for decrypting the variables.
1919

@@ -40,15 +40,15 @@ After that, you can start the first provision stage with `ansible-playbook play.
4040

4141
### 2. Provision machine for its actual purpose
4242

43-
After that, just run the rest of the playbooks for the given machine, accessing it with your own ssh login: `ansible-playbook play.yml --limit=testmachine`. Don't forget to add `--user testuser` if the name of your local user differs from the remote user.
43+
After that, just run the rest of the playbooks for the given machine, accessing it with your own SSH login: `ansible-playbook play.yml --limit=testmachine`. Don't forget to add `--user testuser` if the name of your local user differs from the remote user.
4444

4545
## Provision a machine to buildbotworker
4646

47-
For adding your buildbotworker machine to this repo, we need to follow three steps. The machine does not need to be reachable from the internet. It will connect itself to the buildbot, so it only needs basic access to the internet.
47+
For adding your buildbotworker machine to this repository, we need to follow three steps. The machine does not need to be reachable from the internet. It will connect itself to the buildbot, so it only needs basic access to the internet.
4848

49-
### Get your machine known to ansible
49+
### Get your machine known to Ansible
5050

51-
To get your machine known to ansible, add it to the `hosts`-file at `inventory/hosts`.
51+
To get your machine known to Ansible, add it to the `hosts`-file at `inventory/hosts`.
5252

5353
```ini
5454
[buildbotworker]

0 commit comments

Comments
 (0)