template.md

Writing cue-by-example guides

^{by Jonathan Matthews and Paul Jolly}

Use this file as a template when creating new cue-by-example guides.

Introduction

This introduction explains the broad context of this guide, what technologies it deals with, and what prerequisites the reader must be aware of to use the guide successfully.

Prerequisites

To use this guide, you need to:

• install the cue command
• and perhaps do some other things, as well

Scenario A-1

This scenario can be read in isolation from any other scenario.

❕ Info ❕
A scenario can build on the learnings imparted by other scenarios. However, if its steps cannot be carried out without first completing another scenario, then consider merging the two scenarios into one.

Create some files

This section is a container for the following 2 steps.

➡️ Create cue_file_1.cue

💾 cue_file_1.cue

package foo

some_content: "some string"
some_boolean: true

➡️ Create really_long_file.txt

---

💾 really_long_file.txt (click to open)

A
long
file
but not
really long.

---

Do something with the files

➡️ Audit the files

Count the lines in each file by running:

💻 terminal

wc -l *

Expected output:

 4 cue_file_1.cue
 5 really_long_file.txt
 9 total

❗ WARNING ❗
The file really_long_file.txt is not, in fact, really long. This is a known weakness of this guide. Please feel free to open an issue to track this problem.

Scenario B-2

This is a very short scenario, which can be read separately from Scenario A-1.

Conclusion

This section concludes the guide by:

• reminding the reader about the significant elements of what they've achieved in the guide's different scenarios,
• reminding the reader why the scenarios' outcomes were useful,
• reenforcing any important reminders or warnings, and
• pointing to any additional guides or sites that might be useful to develop the reader's learning further.