Skip to content

Commit bc6c346

Browse files
committed
Fixing grammar in the documentation
1 parent 107c16d commit bc6c346

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

molecule/README.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,9 @@ This directory is the home of the test playbooks:
77

88
# Molecule
99

10-
The default tested version is postgresql 9.6, 10, 11, 12, and 13 on Ubuntu 20.04. We are currently _not_ linting anything.
10+
The default tested version is postgresql 9.6, 10, 11, 12, and 13 on Ubuntu 20.04. Linting is disabled for the tests.
1111

12-
```
13-
lint: |
14-
set -e
15-
# yamllint .
16-
# ansible-lint
17-
```
18-
19-
You can override this with setting the environment variable MOLECULE_DISTRO to one of:
12+
The default distribution is ubuntu2004. You can override th with setting the environment variable MOLECULE_DISTRO to one of:
2013

2114
* centos7
2215
* centos8
@@ -27,12 +20,6 @@ You can override this with setting the environment variable MOLECULE_DISTRO to o
2720
* ubuntu1804
2821
* ubuntu2004
2922

30-
The images we use are extended with systemd by Jeff Geerling. Before we start the tests, `molecule` runs the `prepare.yml` playbook to:
31-
32-
* Create a user called `ansbile`, with the default group membership of either `wheel` (CentOS, Fedora), or `sudo` (Debian, ubuntu)
33-
* Install a couple of packages that Jeff Geerling did not install in his container images, that we need in order to test the role properly
34-
35-
3623
Manual execution of the molecule tests with the distro of your liking. Examples:
3724

3825
```
@@ -41,6 +28,13 @@ MOLECULE_DISTRO=debian10 molecule converge
4128
MOLECULE_DISTRO=ubuntu2004 molecule converge
4229
```
4330

31+
The images we use are extended with systemd by Jeff Geerling. See https://hub.docker.com/u/geerlingguy/
32+
33+
Prior to the testing, molecule runs the prepare.yml playbook to:
34+
35+
* Create a user called `ansible`, with the default group membership of either `wheel` (CentOS, Fedora), or `sudo` (Debian, ubuntu)
36+
* Install a couple of packages that Jeff Geerling did not install in his container images, that are needed in order to test the role properly
37+
4438
The main file ./molecule/default/molecule.yml sets up versions to test from 9.6 to 13.
4539

4640
# Tests
@@ -74,12 +68,19 @@ pip install molecule molecule-docker
7468

7569
# Examples
7670

77-
Examples:
71+
To run molecule tests locally, you can run the following commands:
7872

7973
```
74+
#--- to just create the default containers (ubuntu2004), and run prepare.yml
8075
molecule create
76+
77+
#--- to run the tests and keep the containers
8178
molecule converge
79+
80+
#--- full life cycle of tests
8281
molecule test
82+
83+
#--- to clean up (i.e after converge, if you would like to change to a different distribution)
8384
molecule destroy
8485
8586
#--- with specific distro release
@@ -88,6 +89,7 @@ MOLECULE_DISTRO=ubuntu2004 molecule converge
8889
MOLECULE_DISTRO=ubuntu2004 molecule test
8990
MOLECULE_DISTRO=ubuntu2004 molecule destroy
9091
```
92+
9193
# References
9294

9395
* https://github.com/search?q=user%3Ageerlingguy+docker-.*-ansible

tests/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
For more docu about molecule testing, see ../molecule/README.md
3+
For more documentation about molecule testing, see ../molecule/README.md
44

55
This directory is the home of the test playbooks:
66

0 commit comments

Comments
 (0)