You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: implement tabs for Docker/non-Docker instructions (#165) (#234)
- Convert 6 sections in howto.md to use MkDocs Material tabbed format
- Replace 'With Docker:' / 'Without Docker' headers with tab syntax
- All sections now use '=== "Tab Name"' format for consistent navigation
Co-authored-by: Mariatta <[email protected]>
Copy file name to clipboardExpand all lines: docs/developer/howto.md
+56-50Lines changed: 56 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,47 +15,47 @@ docker-compose logs -f
15
15
16
16
## Creating Migration Files
17
17
18
-
With docker:
18
+
=== "With Docker"
19
19
20
-
```
21
-
make manage makemigrations
22
-
```
20
+
```
21
+
make manage makemigrations
22
+
```
23
23
24
-
Without Docker
24
+
=== "Without Docker"
25
25
26
-
```
27
-
python manage.py makemigrations
28
-
```
26
+
```
27
+
python manage.py makemigrations
28
+
```
29
29
30
30
## Running Migrations
31
31
32
-
With docker:
32
+
=== "With Docker"
33
33
34
-
```
35
-
make manage migrate
36
-
```
34
+
```
35
+
make manage migrate
36
+
```
37
37
38
-
Without Docker
38
+
=== "Without Docker"
39
39
40
-
```
41
-
python manage.py migrate
42
-
```
40
+
```
41
+
python manage.py migrate
42
+
```
43
43
44
44
## Emails in local env
45
45
46
46
When you sign up you'll receive an email with a code to verify your account. In Development those emails don't leave your machine so here's the steps to get the code.
47
47
48
-
### With Docker
48
+
=== "With Docker"
49
49
50
-
The docker compose development environment includes a
51
-
[maildev](https://maildev.github.io/maildev/)
52
-
instance for previewing emails locally.
50
+
The docker compose development environment includes a
51
+
[maildev](https://maildev.github.io/maildev/)
52
+
instance for previewing emails locally.
53
53
54
-
It is accessible at <http://localhost:1080> and will show all emails sent by the application.
54
+
It is accessible at <http://localhost:1080> and will show all emails sent by the application.
55
55
56
-
### Without Docker
56
+
=== "Without Docker"
57
57
58
-
Check your terminal, the email will be printed out for you.
58
+
Check your terminal, the email will be printed out for you.
59
59
60
60
## Set up your Account as a Staff user
61
61
@@ -66,17 +66,17 @@ Check your terminal, the email will be printed out for you.
66
66
5. Your account is now verified.
67
67
6. On the terminal, go to Django shell:
68
68
69
-
With Docker:
69
+
=== "With Docker"
70
70
71
-
```
72
-
make manage shell
73
-
```
71
+
```
72
+
make manage shell
73
+
```
74
74
75
-
Without Docker
75
+
=== "Without Docker"
76
76
77
-
```
78
-
python manage.py shell
79
-
```
77
+
```
78
+
python manage.py shell
79
+
```
80
80
81
81
7. Set your account as a staff and superuser:
82
82
@@ -147,39 +147,45 @@ LANGUAGES = (
147
147
```
148
148
149
149
2. Then you should run the `makemessages` command:
150
-
1. With Docker:
151
-
```
152
-
make create_translations LANG=<locale-code>
153
-
```
154
150
155
-
For example for Brazilian Portuguese:
151
+
=== "With Docker"
156
152
157
-
```
158
-
make create_translations LANG=pt_BR
159
-
```
153
+
```
154
+
make create_translations LANG=<locale-code>
155
+
```
160
156
161
-
2. Without Docker:
162
-
```
163
-
python manage.py makemessages -l <locale-code>
164
-
```
157
+
For example for Brazilian Portuguese:
165
158
166
-
For example for Brazilian Portuguese:
159
+
```
160
+
make create_translations LANG=pt_BR
161
+
```
167
162
168
-
```
169
-
python manage.py makemessages -l pt_BR
170
-
```
163
+
=== "Without Docker"
164
+
165
+
```
166
+
python manage.py makemessages -l <locale-code>
167
+
```
168
+
169
+
For example for Brazilian Portuguese:
170
+
171
+
```
172
+
python manage.py makemessages -l pt_BR
173
+
```
171
174
172
175
Note that for the creation of new languages we use ISO/IEC 15897 for formatting the language tag.
173
176
174
177
3. Translate a couple of messages in the generated `.po` file;
0 commit comments