Use hashes for titles.
This commit is contained in:
parent
89e8c7a821
commit
3e5ad76874
|
|
@ -1,5 +1,4 @@
|
|||
{{ role_name }}
|
||||
=========
|
||||
# {{ role_name }}
|
||||
|
||||
{{ meta.galaxy_info.description }}
|
||||
|
||||
|
|
@ -7,8 +6,7 @@
|
|||
|------|------|-------|---------|
|
||||
|[](https://travis-ci.com/{{ travis_namespace }}/ansible-role-{{ role_name }})|[](https://github.com/{{ github_namespace }}/ansible-role-{{ role_name }}/actions)|[](https://galaxy.ansible.com/{{ github_namespace }}/{{ role_name }})|[](https://galaxy.ansible.com/{{ github_namespace }}/{{ role_name }})|
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
## Example Playbook
|
||||
|
||||
This example is taken from `molecule/resources/converge.yml` and is tested on each push, pull request and release.
|
||||
```yaml
|
||||
|
|
@ -32,16 +30,14 @@ For verification `molecule/resources/verify.yml` run after the role has been app
|
|||
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
|
||||
|
||||
{% if variables.content is defined %}
|
||||
Role Variables
|
||||
--------------
|
||||
## Role Variables
|
||||
|
||||
These variables are set in `defaults/main.yml`:
|
||||
```yaml
|
||||
{{ variables.content | b64decode }}```
|
||||
{% endif %}
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
- Access to a repository containing packages, likely on the internet.
|
||||
- A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)
|
||||
|
|
@ -53,8 +49,7 @@ The following roles can be installed to ensure all requirements are met, using `
|
|||
```
|
||||
|
||||
{% if meta.dependencies %}
|
||||
Dependencies
|
||||
------------
|
||||
## Dependencies
|
||||
|
||||
Most roles require some kind of preparation, this is done in `molecule/default/prepare.yml`. This role has a "hard" dependency on the following roles:
|
||||
|
||||
|
|
@ -62,17 +57,14 @@ Most roles require some kind of preparation, this is done in `molecule/default/p
|
|||
- {{ dependency }}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
Context
|
||||
-------
|
||||
## Context
|
||||
|
||||
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
|
||||
|
||||
Here is an overview of related roles:
|
||||

|
||||
|
||||
|
||||
Compatibility
|
||||
-------------
|
||||
## Compatibility
|
||||
|
||||
This role has been tested on these [container images](https://hub.docker.com/):
|
||||
|
||||
|
|
@ -89,8 +81,7 @@ The minimum version of Ansible required is {{ meta.galaxy_info.min_ansible_versi
|
|||
- The development version.
|
||||
|
||||
{% if exceptions is defined %}
|
||||
Exceptions
|
||||
----------
|
||||
## Exceptions
|
||||
|
||||
Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:
|
||||
|
||||
|
|
@ -100,8 +91,7 @@ Some variarations of the build matrix do not work. These are the variations and
|
|||
{% endfor %}{% endif %}
|
||||
|
||||
{% if versions is defined %}
|
||||
Included version(s)
|
||||
-------------------
|
||||
## Included version(s)
|
||||
|
||||
This role [refers to a version]({{ reference }}) released by {{ project_name }}. Check the released version(s) here:
|
||||
{% for version in versions %}
|
||||
|
|
@ -110,8 +100,7 @@ This role [refers to a version]({{ reference }}) released by {{ project_name }}.
|
|||
|
||||
This version reference means a role may get outdated. Monthly tests occur to see if [bit-rot](https://en.wikipedia.org/wiki/Software_rot) occured. If you however find a problem, please create an issue, I'll get on it as soon as possible.{% endif %}
|
||||
|
||||
Testing
|
||||
-------
|
||||
## Testing
|
||||
|
||||
[Unit tests](https://travis-ci.com/{{ travis_namespace }}/ansible-role-{{ role_name }}) are done on every commit, pull request, release and periodically.
|
||||
|
||||
|
|
@ -145,13 +134,11 @@ image="centos" tox
|
|||
image="debian" tag="stable" tox
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
{{ meta.galaxy_info.license }}
|
||||
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
## Author Information
|
||||
|
||||
[{{ meta.galaxy_info.author }}]({{ author_website }})
|
||||
|
|
|
|||
Loading…
Reference in New Issue