blob: 3eb0c5cd6fbc023eb4070ccccc504e51d5c676aa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# Tutorials
**Learning-oriented documentation** - Learn by doing with step-by-step guidance.
---
## What Are Tutorials?
Tutorials are **lessons** that teach you how to use ngit-grasp through practical, hands-on steps.
**Characteristics:**
- ✅ Learning-oriented (teach beginners)
- ✅ Practical (you follow along)
- ✅ Step-by-step with guaranteed outcomes
- ✅ Complete from start to finish
- ✅ Safe to experiment with
**Not tutorials:**
- ❌ Problem-solving guides (those are How-To)
- ❌ Technical references (those are Reference)
- ❌ Conceptual explanations (those are Explanation)
---
## Available Tutorials
### [Getting Started](getting-started.md)
**Time:** 15-20 minutes
**Learn:** Set up ngit-grasp development environment, build and test the code
**You'll accomplish:**
- Clone and build the project
- Set up Nix development environment
- Run tests successfully
- Understand project structure
**Start here if:** You're brand new to ngit-grasp
---
### [Running Your First Audit](first-audit.md)
**Time:** 10-15 minutes
**Prerequisites:** [Getting Started](getting-started.md) completed
**Learn:** Use grasp-audit to check GRASP compliance
**You'll accomplish:**
- Run compliance tests against a relay
- Interpret audit results
- Use the audit tool library
- Understand GRASP requirements
**Start here if:** You want to test GRASP compliance
---
## Planned Tutorials
### Deploying Your First GRASP Relay
**Status:** 🔜 Planned (waiting for main server implementation)
**You'll learn:**
- Deploy ngit-grasp to production
- Configure for your domain
- Set up HTTPS with reverse proxy
- Create your first repository
---
### Contributing Your First PR
**Status:** 🔜 Planned
**You'll learn:**
- Find an issue to work on
- Set up development environment
- Make changes and test
- Submit a pull request
---
## How to Use Tutorials
1. **Follow in order** - Each step builds on previous ones
2. **Actually do the steps** - Don't just read, type the commands
3. **Expect success** - If something fails, check troubleshooting
4. **Learn by doing** - Understanding comes from practice
**Not sure if this is what you need?**
- Want to solve a specific problem? → [How-To Guides](../how-to/)
- Looking for technical details? → [Reference](../reference/)
- Want to understand the design? → [Explanation](../explanation/)
---
## Contributing Tutorials
When writing a tutorial:
**DO:**
- ✅ Start with a clear learning goal
- ✅ Provide complete, tested steps
- ✅ Include expected output
- ✅ Add troubleshooting section
- ✅ Keep it focused (one topic)
- ✅ Test with a beginner
**DON'T:**
- ❌ Assume prior knowledge (or state prerequisites clearly)
- ❌ Skip steps ("obviously you would...")
- ❌ Explain every detail (link to Explanation docs)
- ❌ Try to cover everything (keep scope small)
See [Diátaxis: Tutorials](https://diataxis.fr/tutorials/) for detailed guidance.
---
*Part of the [ngit-grasp documentation](../README.md) using the [Diátaxis](https://diataxis.fr/) framework.*
|