Skip to content

Commit fd0ebdb

Browse files
committed
docs: restructure diataxis and aggregation
Signed-off-by: Eike Waldt <[email protected]> On-behalf-of: SAP <[email protected]>
1 parent 10eb691 commit fd0ebdb

File tree

3 files changed

+21
-10
lines changed

3 files changed

+21
-10
lines changed

docs/how-to/release.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Python Gardenlinux Lib - Release Process"
3-
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/release.md"
2+
title: Release Process - Python Library
3+
description: Release a new version of the Garden Linux Python Library
44
migration_status: "new"
55
migration_source: ""
66
migration_issue: ""
@@ -9,6 +9,7 @@ migration_approved: false
99
github_org: gardenlinux
1010
github_repo: python-gardenlinux-lib
1111
github_source_path: docs/how-to/release.md
12+
github_target_path: docs/how-to/python-gardenlinux-lib-release.md
1213
---
1314

1415
# Release Documentation
@@ -59,6 +60,12 @@ command line.
5960
```
6061

6162
Or in `requirements.txt`:
63+
6264
```
6365
gardenlinux @ git+https://github.com/gardenlinux/[email protected]
6466
```
67+
68+
## Next Steps
69+
70+
- [Python Library](/reference/supporting_tools/python-gardenlinux-lib.md)
71+
- [Command-Line Interface - Python Library](/reference/python-gardenlinux-lib-cli.md)

docs/overview/index.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ migration_approved: false
99
github_org: gardenlinux
1010
github_repo: python-gardenlinux-lib
1111
github_source_path: docs/overview/index.md
12-
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md"
12+
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib.md"
1313
---
1414

1515
# Garden Linux Python Library Documentation
@@ -18,8 +18,6 @@ Welcome to the Garden Linux Python Library documentation. This library provides
1818
Python tools and utilities for working with Garden Linux features, flavors, OCI
1919
artifacts, S3 buckets, and GitHub releases.
2020

21-
![Garden Linux Logo](../_static/gardenlinux-logo.svg)
22-
2321
## Overview
2422

2523
The Garden Linux Python Library is a comprehensive toolkit for managing and
@@ -51,7 +49,7 @@ For detailed Python API documentation, including all modules, classes, and
5149
functions, see the
5250
[API Reference on ReadTheDocs](https://gardenlinux.github.io/python-gardenlinux-lib/api.html).
5351

54-
## Documentation Sections
52+
## Next Steps
5553

56-
- [Command-Line Interface](../how-to/cli.md)
57-
- [Release documentation](../how-to/release.md)
54+
- [Command-Line Interface - Python Library](/reference/python-gardenlinux-lib-cli.md)
55+
- [Release Process - Python Library](/how-to/python-gardenlinux-lib-release.md)
Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Python Gardenlinux Lib - CLI"
3-
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/cli.md"
2+
title: Command-Line Interface - Python Library
3+
description: Commandline Reference for the Python Library
44
migration_status: "new"
55
migration_source: ""
66
migration_issue: ""
@@ -9,6 +9,7 @@ migration_approved: false
99
github_org: gardenlinux
1010
github_repo: python-gardenlinux-lib
1111
github_source_path: docs/how-to/cli.md
12+
github_target_path: docs/reference/python-gardenlinux-lib-cli.md
1213
---
1314

1415
# Command-Line Interface
@@ -89,3 +90,8 @@ Commands:
8990
- `create` - Create a new release
9091
- `update` - Update an existing release
9192
- `list` - List all releases
93+
94+
## Next Steps
95+
96+
- [Python Library](/reference/supporting_tools/python-gardenlinux-lib.md)
97+
- [Release Process - Python Library](/how-to/python-gardenlinux-lib-release.md)

0 commit comments

Comments
 (0)