File tree Expand file tree Collapse file tree 3 files changed +34
-1
lines changed Expand file tree Collapse file tree 3 files changed +34
-1
lines changed Original file line number Diff line number Diff line change @@ -56,19 +56,37 @@ for Zed, with VS Code and NeoVim on the way.
56
56
To give a sense of the flavour of the language, here are a small selection of
57
57
Technique source files rendered to PDFs using the _ technique render_ command.
58
58
59
- First, from a the recipe for a roast turkey during the holidays:
59
+ ### Systems and Operations
60
+
61
+ One of the original use cases behind this work was wanting to document the
62
+ procedures used in systems administration and network operations. This example
63
+ shows a simple list of such tasks:
64
+
65
+ <a href =" tests/samples/LocalNetwork.tq " >
66
+ <img width =613 src =" examples/screenshots/LocalNetwork.png " >
67
+ </a >
68
+
69
+ ### Recipes
70
+
71
+ Preparing a meal during the holidays is also a list of tasks, but often more
72
+ than one person needs to do things concurrently:
60
73
61
74
<a href =" examples/prototype/ChristmasTurkey.tq " >
62
75
<img width =608 src =" examples/screenshots/ChristmasTurkey.png " >
63
76
</a >
64
77
78
+
79
+ ### Instructions
80
+
65
81
This from a set of instructions guiding staff of what to do when an incident
66
82
occurs:
67
83
68
84
<a href =" examples/prototype/DontPanic.tq " >
69
85
<img width =593 src =" examples/screenshots/DontPanic.png " >
70
86
</a >
71
87
88
+ ### Larger processes
89
+
72
90
Finally, an example showing using Technique to describe a much larger
73
91
procedure, in this case the entire process of doing systems engineering on a
74
92
software project. This pushes the limits of what the language is for, but
Original file line number Diff line number Diff line change
1
+ local_network :
2
+
3
+ # Local Network Connectivity
4
+
5
+ Establish that the local network environment is functioning.
6
+
7
+ 1. Check physical network interface { exec(
8
+ ```bash
9
+ ip addr
10
+ ```
11
+ ) } and look for eth0 being marked UP.
12
+ 2. Check local network connectivity
13
+ 3. Check local DHCP is working
14
+ 4. Check local DNS responding
15
+ 5. Verify reachability of local network gateway
You can’t perform that action at this time.
0 commit comments