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
Copy file name to clipboardExpand all lines: docs/DEVELOPMENT.md
+18-75Lines changed: 18 additions & 75 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,6 @@
1
-
# Documentation Development Guide
1
+
# Content Development Guide
2
2
3
-
Guide for developers working with AWS Deep Learning Containers documentation.
4
-
5
-
## Quick Start
6
-
7
-
```bash
8
-
cd /path/to/deep-learning-containers
9
-
source .venv/bin/activate
10
-
cd docs/src && python main.py --verbose
11
-
```
3
+
Guide for adding and modifying generated content in AWS Deep Learning Containers documentation. For site setup and local development, see [README.md](README.md).
To add additional fields, ensure that the image configuration YAML file contains said field of the same name.
191
183
Additionally, if you require the field to be formatted, add an additional attribute in `ImageConfig` class of `display_<field_name>` to grab the formatted field.
Run `main.py` to generate documentation without serving:
247
-
248
-
```bash
249
-
cd docs/src && python main.py --verbose
250
-
```
251
-
252
-
This automatically clones `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories without starting a web server.
253
-
254
-
### Serving Locally
255
-
256
-
Use `mkdocs serve` to automatically clone `tutorials/` and generate documentation in `reference/` and `releasenotes/` and serve the website:
257
-
258
-
```bash
259
-
cd docs && mkdocs serve
260
-
```
261
-
262
-
The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.
263
-
264
-
### Live Reload
265
-
266
-
Enable automatic reload on content changes:
267
-
268
-
```bash
269
-
mkdocs serve --livereload
270
-
```
212
+
---
271
213
272
-
**Note:** Live reload only detects changes to:
214
+
## Tutorials Changes
273
215
274
-
- Markdown file content
275
-
- `.nav.yml`content
276
-
- `mkdocs.yml`content
216
+
For any changes required to the tutorial pages, create a new PR in
Live reload does **not** detect changes requiring documentation regeneration (e.g., image config YAML files, templates). To regenerate documentation, stop the server (`Ctrl+C`) and rerun `mkdocs serve`.
219
+
> **Important**: When making changes to the tutorials page, make sure that you update the tutorials
220
+
> [index.md](https://github.com/aws-samples/sample-aws-deep-learning-containers/blob/main/index.md) and
Copy file name to clipboardExpand all lines: docs/README.md
+40-16Lines changed: 40 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,59 @@
1
-
# Documentation Development Runbook
1
+
# Documentation Website Guide
2
2
3
-
## Prerequisites
3
+
Guide for setting up, running, and configuring the MkDocs documentation site. For adding or modifying generated content (images, release notes, support policy), see [DEVELOPMENT.md](DEVELOPMENT.md).
4
4
5
-
Follow the environment setup instructions in [DEVELOPMENT.md](../DEVELOPMENT.md), then install documentation dependencies:
5
+
## Prerequisites
6
6
7
7
```bash
8
+
# Set up virtual environment from repository root
9
+
cd /path/to/deep-learning-containers
10
+
python -m venv .venv
11
+
source .venv/bin/activate
8
12
pip install -r docs/requirements.txt
9
13
```
10
14
11
15
## Local Development
12
16
13
-
Start the development server with live reload:
17
+
### Generation Only
18
+
19
+
Run the generation system without serving:
20
+
```bash
21
+
cd docs/src && python main.py --verbose
22
+
```
23
+
This clones the `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories.
24
+
25
+
Generation flags:
26
+
```bash
27
+
python main.py --available-images-only
28
+
python main.py --support-policy-only
29
+
python main.py --release-notes-only
30
+
python main.py --index-only
31
+
```
14
32
33
+
### Serving
34
+
35
+
Use `mkdocs serve` to generate documentation and serve the website:
15
36
```bash
16
-
mkdocs serve
37
+
cd docs &&mkdocs serve
17
38
```
39
+
The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.
40
+
41
+
### Live Reload
42
+
43
+
Enable automatic reload on content changes:
44
+
```bash
45
+
mkdocs serve --livereload
46
+
```
47
+
**Note:** Live reload only detects changes to:
48
+
- Markdown file content
49
+
-`.nav.yml` content
50
+
-`mkdocs.yml` content
51
+
52
+
Live reload does **not** detect changes requiring documentation regeneration (e.g., image config YAML files, templates). To regenerate documentation, stop the server (`Ctrl+C`) and rerun `mkdocs serve`.
18
53
19
54
## Navigation
20
55
21
56
Site navigation is managed centrally in `docs/.nav.yml` using the `awesome-nav` plugin. Structure:
22
-
23
57
```yaml
24
58
nav:
25
59
- Home: index.md
@@ -34,7 +68,6 @@ nav:
34
68
Key settings in `mkdocs.yaml`:
35
69
36
70
**Theme Palette** - Modify color scheme under `theme.palette`:
37
-
38
71
```yaml
39
72
theme:
40
73
palette:
@@ -44,19 +77,10 @@ theme:
44
77
```
45
78
46
79
**Plugins** - Add/remove plugins under `plugins`:
47
-
48
80
```yaml
49
81
plugins:
50
82
- search
51
83
- autorefs
52
84
- awesome-nav
53
85
```
54
86
55
-
## Tutorials Changes
56
-
57
-
For any changes required to the tutorial pages, create a new PR in
0 commit comments