Skip to content

Commit fe90c77

Browse files
committed
docs: point at examples repository
1 parent 142aec6 commit fe90c77

File tree

3 files changed

+4
-11
lines changed

3 files changed

+4
-11
lines changed

docs/examples.rst

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
11
Example Deploys
22
===============
33

4-
If you are getting started with pyinfra checkout `the examples on GitHub <https://github.com/Fizzadar/pyinfra/tree/2.x/examples>`_ which should properly introduce the file/folder structure as well as operation basics.
5-
6-
Included here is a set of documented example deploys highlighting common patterns and best practices:
7-
8-
.. toctree::
9-
:maxdepth: 2
10-
:glob:
11-
12-
examples/*
4+
This content has been moved to `the examples GitHub repository <https://github.com/pyinfra-dev/pyinfra-examples>`_.

docs/examples/dynamic_execution_deploy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Dynamic Execution during Deploy
22

3+
**Note:** this example is out of date (the code is valid, but there's better ways to do it), please see [using operations: operation output & callbacks](/using-operations).
4+
35
pyinfra is designed around the idea of defining the end-state _before_ executing any changes on the remote server. Generally this works well but sometimes you need the output of one command to feed into another. This can be achieved by executing Python functions mid-deploy.
46

57
In this example we install a service (ZeroTier) that generates a random ID for the remote host. We then use this ID to authenticate the server with the ZeroTier API.

docs/using-operations.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,5 +342,4 @@ Examples
342342

343343
A great way to learn more about writing pyinfra deploys is to see some in action. There's a number of resources for this:
344344

345-
- `the pyinfra examples folder on GitHub <https://github.com/Fizzadar/pyinfra/tree/2.x/examples>`_ - a general collection of all kinds of example deploy
346-
- :doc:`the example deploys in this documentation <./examples>` - these highlight specific common patterns
345+
- `the pyinfra examples repository on GitHub <https://github.com/pyinfra-dev/pyinfra-examples>`_

0 commit comments

Comments
 (0)