Skip to content

Commit be7fd06

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 be7fd06

File tree

4 files changed

+86
-101
lines changed

4 files changed

+86
-101
lines changed

docs/how-to/cli.md

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

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/python-gardenlinux-lib.git@1.0.0
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: 6 additions & 8 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
@@ -37,21 +35,21 @@ interacting with Garden Linux components. It includes:
3735
### Command-Line Interface
3836

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

4341
### Release Management
4442

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

4846
### API Reference
4947

5048
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)

docs/reference/cli.md

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

0 commit comments

Comments
 (0)