Tidy formatting in compatibility doc.
# Compatibility
-This page describes the compatibility guarantees ``pyinfra`` offers.
+This page describes the compatibility guarantees `pyinfra` offers.
-## ``pyinfra`` Versions
+## `pyinfra` Versions
-Where possible ``pyinfra`` follows [semantic versioning](https://semver.org/) rules. This means no breaking changes between minor versions (`1.0` -> `1.1`). Such changes are reserved for major version increases only. ``pyinfra`` will also generate warnings in CLI mode for any deprecated features due to be removed at the next major release. These are the `pyinfra` specific semver rules:
+Where possible `pyinfra` follows [semantic versioning](https://semver.org/) rules. This means no breaking changes between minor versions (`1.0` -> `1.1`). Such changes are reserved for major version increases only. `pyinfra` will also generate warnings in CLI mode for any deprecated features due to be removed at the next major release. These are the `pyinfra` specific semver rules:
+ **Major**: breaking changes, warnings will show on latest previous major version
+ **Minor**: new operations, new APIs, new global arguments, deprecate & add warnings
@@ -13,18 +13,18 @@ Where possible ``pyinfra`` follows [semantic versioning](https://semver.org/) r
## Control Systems
-``pyinfra`` works on anywhere that runs Python - Mac, Linux & Windows are all supported.
+`pyinfra` works on anywhere that runs Python - Mac, Linux & Windows are all supported.
### Editor Integration
#### PyCharm
-To debug ``pyinfra`` within PyCharm, you need to [explicitly enable support for Gevent](https://blog.jetbrains.com/pycharm/2012/08/gevent-debug-support/).
+To debug `pyinfra` within PyCharm, you need to [explicitly enable support for Gevent](https://blog.jetbrains.com/pycharm/2012/08/gevent-debug-support/).
## Remote Systems
-``pyinfra`` aims to be compatible with all Unix-like operating systems and is currently tested against:
+`pyinfra` aims to be compatible with all Unix-like operating systems and is currently tested against:
+ Ubuntu 16/18/20
+ Debian 8/9
@@ -39,19 +39,19 @@ To debug ``pyinfra`` within PyCharm, you need to [explicitly enable support for
In general, the only requirement on the remote side is shell access. POSIX commands are used where possible for facts and operations, so most of the ``server`` and ``files`` operations should work anywhere POSIX.
-## Upgrading ``pyinfra`` from ``0.x`` -> ``1.x``
+## Upgrading `pyinfra` from ``0.x`` -> ``1.x``
-The move to `v1` removes a lot of old legacy functionality in `pyinfra` - there will be warnings written to the user in CLI mode if any of these are encountered. The full list can be seen [on the changelog](https://github.com/Fizzadar/pyinfra/blob/master/CHANGELOG.md#v1). In addition to these removals, `v1` brings a few major changes and deprecates the old methods. Again, ``pyinfra`` will output warnings when these are encountered, and support will be removed in `v2`.
+The move to `v1` removes a lot of old legacy functionality in `pyinfra` - there will be warnings written to the user in CLI mode if any of these are encountered. The full list can be seen [on the changelog](https://github.com/Fizzadar/pyinfra/blob/master/CHANGELOG.md#v1). In addition to these removals, `v1` brings a few major changes and deprecates the old methods. Again, `pyinfra` will output warnings when these are encountered, and support will be removed in `v2`.
### Rename the modules module
`v1` has moved where operations are imported from to make more sense:
```py
-# Old, 0.x style:
+# Old, 0.x import:
from pyinfra.modules import server
-# New, 1.x style:
+# New, 1.x import:
from pyinfra.operations import server
```
