Skip to content

Commit 73a16ad

Browse files
committed
docs: restructure diataxis and aggregation
Signed-off-by: Eike Waldt <waldt@b1-systems.de> On-behalf-of: SAP <eike.waldt@sap.com>
1 parent 10eb691 commit 73a16ad

4 files changed

Lines changed: 93 additions & 103 deletions

File tree

docs/how-to/cli.md

Lines changed: 0 additions & 91 deletions
This file was deleted.

docs/how-to/release.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
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
4+
related_topics:
5+
- /reference/supporting_tools/python-gardenlinux-lib.md
6+
- /reference/python-gardenlinux-lib-cli.md
7+
- /how-to/python-gardenlinux-lib-release.md
48
migration_status: "new"
59
migration_source: ""
610
migration_issue: ""
@@ -9,6 +13,7 @@ migration_approved: false
913
github_org: gardenlinux
1014
github_repo: python-gardenlinux-lib
1115
github_source_path: docs/how-to/release.md
16+
github_target_path: docs/how-to/python-gardenlinux-lib-release.md
1217
---
1318

1419
# Release Documentation
@@ -29,12 +34,10 @@ command line.
2934
1. **Set version files:**
3035

3136
_python-gardenlinux-lib_ versioning needs to be set in:
32-
3337
- `pyproject.toml`
3438
- `.github/actions/setup/action.yml`
3539

3640
Additionally at the moment (removal pending):
37-
3841
- `.github/actions/features_parse/action.yml`
3942
- `.github/actions/flavors_parse/action.yml`
4043

@@ -59,6 +62,11 @@ command line.
5962
```
6063

6164
Or in `requirements.txt`:
65+
6266
```
6367
gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0
6468
```
69+
70+
## Related Topics
71+
72+
<RelatedTopics />

docs/overview/index.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
---
22
title: "Python Library"
33
description: An overview of the Garden Linux Python Library
4+
related_topics:
5+
- /reference/supporting_tools/python-gardenlinux-lib.md
6+
- /reference/python-gardenlinux-lib-cli.md
7+
- /how-to/python-gardenlinux-lib-release.md
48
migration_status: "new"
59
migration_source: ""
610
migration_issue: ""
@@ -9,7 +13,7 @@ migration_approved: false
913
github_org: gardenlinux
1014
github_repo: python-gardenlinux-lib
1115
github_source_path: docs/overview/index.md
12-
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md"
16+
github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib.md"
1317
---
1418

1519
# Garden Linux Python Library Documentation
@@ -18,8 +22,6 @@ Welcome to the Garden Linux Python Library documentation. This library provides
1822
Python tools and utilities for working with Garden Linux features, flavors, OCI
1923
artifacts, S3 buckets, and GitHub releases.
2024

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

2527
The Garden Linux Python Library is a comprehensive toolkit for managing and
@@ -37,21 +39,20 @@ interacting with Garden Linux components. It includes:
3739
### Command-Line Interface
3840

3941
The library provides several command-line tools for common operations. See the
40-
[Command-Line Interface documentation](../how-to/cli.md) for detailed
42+
[Command-Line Interface documentation](/reference/python-gardenlinux-lib-cli.md) for detailed
4143
information about all available commands.
4244

4345
### Release Management
4446

4547
For information about versioning and release procedures, see the
46-
[Release documentation](../how-to/release.md).
48+
[Release documentation](/how-to/python-gardenlinux-lib-release.md).
4749

4850
### API Reference
4951

5052
For detailed Python API documentation, including all modules, classes, and
5153
functions, see the
5254
[API Reference on ReadTheDocs](https://gardenlinux.github.io/python-gardenlinux-lib/api.html).
5355

54-
## Documentation Sections
56+
## Related Topics
5557

56-
- [Command-Line Interface](../how-to/cli.md)
57-
- [Release documentation](../how-to/release.md)
58+
<RelatedTopics />

docs/reference/cli.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Command-Line Interface - Python Library
3+
description: Command-Line Interface of the Garden Linux Python Library
4+
related_topics:
5+
- /reference/supporting_tools/python-gardenlinux-lib.md
6+
- /reference/python-gardenlinux-lib-cli.md
7+
- /how-to/python-gardenlinux-lib-release.md
8+
migration_status: "new"
9+
migration_source: ""
10+
migration_issue: ""
11+
migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter"
12+
migration_approved: false
13+
github_org: gardenlinux
14+
github_repo: python-gardenlinux-lib
15+
github_source_path: docs/reference/cli.md
16+
github_target_path: docs/reference/python-gardenlinux-lib-cli.md
17+
---
18+
19+
# Documentation
20+
21+
_python-gardenlinux-lib_ strictly follows the syntax and intention of
22+
[Semantic Versioning](https://www.semver.org). Each release reflects the
23+
intention and expected impact therefore.
24+
25+
A new release is done by tagging a commit with a valid version. This will create
26+
a GitHub pre-release for proof-reading. Once done a new release can be published
27+
using GitHub CLI or UI.
28+
29+
Newly added docstrings should contain the first version supporting the new API /
30+
command line.
31+
32+
## Step by Step Guide
33+
34+
1. **Set version files:**
35+
36+
_python-gardenlinux-lib_ versioning needs to be set in:
37+
- `pyproject.toml`
38+
- `.github/actions/setup/action.yml`
39+
40+
Additionally at the moment (removal pending):
41+
- `.github/actions/features_parse/action.yml`
42+
- `.github/actions/flavors_parse/action.yml`
43+
44+
2. **Create git tag:**
45+
46+
```bash
47+
git tag <tag>
48+
```
49+
50+
3. **Review and publish:**
51+
52+
Review the generated pre-release changelog by visiting the GitHub project
53+
release page and publish it if applicable.
54+
55+
4. **Consume the library:**
56+
57+
Projects consuming the _python-gardenlinux-lib_ may use the following git URL
58+
for dependency definition:
59+
60+
```bash
61+
pip install git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0
62+
```
63+
64+
Or in `requirements.txt`:
65+
66+
```
67+
gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0
68+
```
69+
70+
## Related Topics
71+
72+
<RelatedTopics />

0 commit comments

Comments
 (0)