Skip to content

Commit f9b3ee1

Browse files
committed
update README and DEVELOPMENT for docs
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 0c0eabd commit f9b3ee1

File tree

2 files changed

+58
-91
lines changed

2 files changed

+58
-91
lines changed

docs/DEVELOPMENT.md

Lines changed: 18 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
# Documentation Development Guide
1+
# Content Development Guide
22

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).
124

135
## Directory Structure
146

@@ -42,7 +34,7 @@ docs/
4234
└── mkdocs.yml
4335
```
4436

45-
______________________________________________________________________
37+
---
4638

4739
## Adding a New Image
4840

@@ -76,7 +68,7 @@ See `docs/src/data/template/image-template.yml` for all available fields.
7668
cd docs/src && python main.py --verbose
7769
```
7870

79-
______________________________________________________________________
71+
---
8072

8173
## Adding Support Policy Dates
8274

@@ -94,7 +86,7 @@ eop: "2026-10-15" # End of Patch date
9486

9587
**Validation:** All images in the same framework group with the same full version (X.Y.Z) must have identical GA/EOP dates.
9688

97-
______________________________________________________________________
89+
---
9890

9991
## Adding Release Notes
10092

@@ -143,7 +135,7 @@ Section headers in optional sections are rendered via the section key.
143135
To format your optional section headers, add a new field in `docs/src/global.yml` under `display_names` section.
144136
Eg: deprecation_notice section will render its header as `## deprecation_notice` unless a formatted string is provided in `docs/src/global.yml`.
145137

146-
______________________________________________________________________
138+
---
147139

148140
## Adding a New Repository
149141

@@ -171,7 +163,7 @@ ______________________________________________________________________
171163
- my-repo
172164
```
173165

174-
______________________________________________________________________
166+
---
175167

176168
## Editing Table Columns
177169

@@ -190,7 +182,7 @@ columns:
190182
To add additional fields, ensure that the image configuration YAML file contains said field of the same name.
191183
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.
192184

193-
______________________________________________________________________
185+
---
194186

195187
## Legacy Support Data
196188

@@ -205,7 +197,7 @@ pytorch:
205197

206198
Generally, this is only required if an image configuration file does not already exist and the image is already past its support.
207199

208-
______________________________________________________________________
200+
---
209201

210202
## Global Configuration
211203

@@ -217,67 +209,18 @@ ______________________________________________________________________
217209
- **table_order:** Order of tables displayed within the documentations website (eg: available_images.md and support_policy.md)
218210
- **platforms/accelerators:** Display mappings
219211

220-
______________________________________________________________________
221-
222-
## Running Generation
223-
224-
```bash
225-
# Help
226-
python main.py --help
227-
228-
# Full generation
229-
python main.py --verbose
230-
231-
# Specific outputs
232-
python main.py --available-images-only
233-
python main.py --support-policy-only
234-
python main.py --release-notes-only
235-
236-
# Preview site
237-
cd docs && mkdocs serve
238-
```
239-
240-
______________________________________________________________________
241-
242-
## Local Documentation Development
243-
244-
### Generation Only (No Server)
245-
246-
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+
---
271213

272-
**Note:** Live reload only detects changes to:
214+
## Tutorials Changes
273215

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
217+
[aws-samples/sample-aws-deep-learning-containers](https://github.com/aws-samples/sample-aws-deep-learning-containers.git).
277218

278-
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
221+
> [.nav.yaml](https://github.com/aws-samples/sample-aws-deep-learning-containers/blob/main/.nav.yml) accordingly.
279222

280-
______________________________________________________________________
223+
---
281224

282225
## Troubleshooting
283226

@@ -286,4 +229,4 @@ ______________________________________________________________________
286229
| "Display name not found" | Add repository to `display_names` in `global.yml` |
287230
| "Inconsistent dates" | Ensure all images in same framework group/version have identical GA/EOP |
288231
| Images not appearing | Check repository is in `table_order` |
289-
| Release notes not generating | Ensure `announcements` and `packages` fields are present |
232+
| Release notes not generating | Ensure `announcements` and `packages` fields are present |

docs/README.md

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,59 @@
1-
# Documentation Development Runbook
1+
# Documentation Website Guide
22

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).
44

5-
Follow the environment setup instructions in [DEVELOPMENT.md](../DEVELOPMENT.md), then install documentation dependencies:
5+
## Prerequisites
66

77
```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
812
pip install -r docs/requirements.txt
913
```
1014

1115
## Local Development
1216

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+
```
1432

33+
### Serving
34+
35+
Use `mkdocs serve` to generate documentation and serve the website:
1536
```bash
16-
mkdocs serve
37+
cd docs && mkdocs serve
1738
```
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`.
1853

1954
## Navigation
2055

2156
Site navigation is managed centrally in `docs/.nav.yml` using the `awesome-nav` plugin. Structure:
22-
2357
```yaml
2458
nav:
2559
- Home: index.md
@@ -34,7 +68,6 @@ nav:
3468
Key settings in `mkdocs.yaml`:
3569

3670
**Theme Palette** - Modify color scheme under `theme.palette`:
37-
3871
```yaml
3972
theme:
4073
palette:
@@ -44,19 +77,10 @@ theme:
4477
```
4578

4679
**Plugins** - Add/remove plugins under `plugins`:
47-
4880
```yaml
4981
plugins:
5082
- search
5183
- autorefs
5284
- awesome-nav
5385
```
5486

55-
## Tutorials Changes
56-
57-
For any changes required to the tutorial pages, create a new PR in
58-
[aws-samples/sample-aws-deep-learning-containers](https://github.com/aws-samples/sample-aws-deep-learning-containers.git).
59-
60-
> **Important**: When making changes to the tutorials page, make sure that you update the tutorials
61-
> [index.md](https://github.com/aws-samples/sample-aws-deep-learning-containers/blob/main/index.md) and
62-
> [.nav.yaml](https://github.com/aws-samples/sample-aws-deep-learning-containers/blob/main/.nav.yml) accordingly.

0 commit comments

Comments
 (0)