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.
5656To give a sense of the flavour of the language, here are a small selection of
5757Technique source files rendered to PDFs using the _ technique render_ command.
5858
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:
6073
6174<a href =" examples/prototype/ChristmasTurkey.tq " >
6275<img width =608 src =" examples/screenshots/ChristmasTurkey.png " >
6376</a >
6477
78+
79+ ### Instructions
80+
6581This from a set of instructions guiding staff of what to do when an incident
6682occurs:
6783
6884<a href =" examples/prototype/DontPanic.tq " >
6985<img width =593 src =" examples/screenshots/DontPanic.png " >
7086</a >
7187
88+ ### Larger processes
89+
7290Finally, an example showing using Technique to describe a much larger
7391procedure, in this case the entire process of doing systems engineering on a
7492software 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