From c3020af964d92bcd9cd020796b7b2edba284f624 Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Thu, 26 Mar 2026 15:32:14 +0100 Subject: [PATCH 1/6] Docs: Migrate structure to diataxes framework in markdown documents --- docs/contributing/.gitkeep | 0 docs/explanation/.gitkeep | 0 docs/how-to/cli.md | 78 ++++++++++++++++++++++++++++++++++++++ docs/how-to/release.md | 51 +++++++++++++++++++++++++ docs/overview/index.md | 43 +++++++++++++++++++++ docs/reference/.gitkeep | 0 docs/tutorials/.gitkeep | 0 7 files changed, 172 insertions(+) create mode 100644 docs/contributing/.gitkeep create mode 100644 docs/explanation/.gitkeep create mode 100644 docs/how-to/cli.md create mode 100644 docs/how-to/release.md create mode 100644 docs/overview/index.md create mode 100644 docs/reference/.gitkeep create mode 100644 docs/tutorials/.gitkeep diff --git a/docs/contributing/.gitkeep b/docs/contributing/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/explanation/.gitkeep b/docs/explanation/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/how-to/cli.md b/docs/how-to/cli.md new file mode 100644 index 00000000..302b3152 --- /dev/null +++ b/docs/how-to/cli.md @@ -0,0 +1,78 @@ +# Command-Line Interface + +This page documents all available command-line tools provided by +python-gardenlinux-lib. Run `command --help` for detailed usage information. + +## Features Commands + +### gl-cname + +Generate a canonical name (cname) from feature sets. + +```bash +gl-cname [options] +``` + +### gl-features-parse + +Parse and extract information from GardenLinux features. + +```bash +gl-features-parse [options] +``` + +## Flavors Commands + +### gl-flavors-parse + +Parse flavors.yaml and generate combinations. + +```bash +gl-flavors-parse [options] +``` + +## OCI Commands + +### gl-oci + +Push OCI artifacts to a registry and manage manifests. + +```bash +gl-oci [command] [options] +``` + +Commands: + +- `push` - Push OCI artifacts to a registry +- `manifest` - Manage OCI manifests + +## S3 Commands + +### gl-s3 + +Upload and download artifacts from S3 buckets. + +```bash +gl-s3 [command] [options] +``` + +Commands: + +- `upload` - Upload artifacts to S3 +- `download` - Download artifacts from S3 + +## GitHub Commands + +### gl-gh-release + +Create and manage GitHub releases. + +```bash +gl-gh-release [command] [options] +``` + +Commands: + +- `create` - Create a new release +- `update` - Update an existing release +- `list` - List all releases diff --git a/docs/how-to/release.md b/docs/how-to/release.md new file mode 100644 index 00000000..f84f27ad --- /dev/null +++ b/docs/how-to/release.md @@ -0,0 +1,51 @@ +# Release Documentation + +_python-gardenlinux-lib_ strictly follows the syntax and intention of +[Semantic Versioning](https://www.semver.org). Each release reflects the +intention and expected impact therefore. + +A new release is done by tagging a commit with a valid version. This will create +a GitHub pre-release for proof-reading. Once done a new release can be published +using GitHub CLI or UI. + +Newly added docstrings should contain the first version supporting the new API / +command line. + +## Step by Step Guide + +1. **Set version files:** + + _python-gardenlinux-lib_ versioning needs to be set in: + + - `pyproject.toml` + - `.github/actions/setup/action.yml` + + Additionally at the moment (removal pending): + + - `.github/actions/features_parse/action.yml` + - `.github/actions/flavors_parse/action.yml` + +2. **Create git tag:** + + ```bash + git tag + ``` + +3. **Review and publish:** + + Review the generated pre-release changelog by visiting the GitHub project + release page and publish it if applicable. + +4. **Consume the library:** + + Projects consuming the _python-gardenlinux-lib_ may use the following git URL + for dependency definition: + + ```bash + pip install git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 + ``` + + Or in `requirements.txt`: + ``` + gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 + ``` diff --git a/docs/overview/index.md b/docs/overview/index.md new file mode 100644 index 00000000..7629c08f --- /dev/null +++ b/docs/overview/index.md @@ -0,0 +1,43 @@ +# Garden Linux Python Library Documentation + +Welcome to the Garden Linux Python Library documentation. This library provides +Python tools and utilities for working with Garden Linux features, flavors, OCI +artifacts, S3 buckets, and GitHub releases. + +![Garden Linux Logo](../_static/gardenlinux-logo.svg) + +## Overview + +The Garden Linux Python Library is a comprehensive toolkit for managing and +interacting with Garden Linux components. It includes: + +- **Feature Management**: Parse and work with Garden Linux features and generate + canonical names +- **Flavor Processing**: Parse flavors.yaml and generate combinations +- **OCI Operations**: Push OCI artifacts to registries and manage manifests +- **S3 Integration**: Upload and download artifacts from S3 buckets +- **GitHub Integration**: Create and manage GitHub releases with release notes + +## Quick Start + +### Command-Line Interface + +The library provides several command-line tools for common operations. See the +[Command-Line Interface documentation](../reference/cli.md) for detailed +information about all available commands. + +### Release Management + +For information about versioning and release procedures, see the +[Release documentation](../how-to/release.md). + +### API Reference + +For detailed Python API documentation, including all modules, classes, and +functions, see the +[API Reference on ReadTheDocs](https://gardenlinux.github.io/python-gardenlinux-lib/api.html). + +## Documentation Sections + +- [Command-Line Interface](../reference/cli.md) +- [Release documentation](../how-to/release.md) diff --git a/docs/reference/.gitkeep b/docs/reference/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/docs/tutorials/.gitkeep b/docs/tutorials/.gitkeep new file mode 100644 index 00000000..e69de29b From 9142fccc3d83ab51759db7d328fa19166bc1df63 Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Wed, 1 Apr 2026 10:44:24 +0200 Subject: [PATCH 2/6] Docs: Add front matter to docs --- docs/how-to/cli.md | 13 +++++++++++++ docs/how-to/release.md | 13 +++++++++++++ docs/overview/index.md | 17 +++++++++++++++-- test-data/gardenlinux | 2 +- 4 files changed, 42 insertions(+), 3 deletions(-) diff --git a/docs/how-to/cli.md b/docs/how-to/cli.md index 302b3152..959ca900 100644 --- a/docs/how-to/cli.md +++ b/docs/how-to/cli.md @@ -1,3 +1,16 @@ +--- +title: "Python Gardenlinux Lib - CLI" +github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/cli.md" +migration_status: "new" +migration_source: "" +migration_issue: "" +migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" +migration_approved: false +github_org: gardenlinux +github_repo: python-gardenlinux-lib +github_source_path: docs/how-to/cli.md +--- + # Command-Line Interface This page documents all available command-line tools provided by diff --git a/docs/how-to/release.md b/docs/how-to/release.md index f84f27ad..b7c7bd30 100644 --- a/docs/how-to/release.md +++ b/docs/how-to/release.md @@ -1,3 +1,16 @@ +--- +title: "Python Gardenlinux Lib - Release Process" +github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/release.md" +migration_status: "new" +migration_source: "" +migration_issue: "" +migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" +migration_approved: false +github_org: gardenlinux +github_repo: python-gardenlinux-lib +github_source_path: docs/how-to/release.md +--- + # Release Documentation _python-gardenlinux-lib_ strictly follows the syntax and intention of diff --git a/docs/overview/index.md b/docs/overview/index.md index 7629c08f..99fdb903 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,3 +1,16 @@ +--- +title: "Python Gardenlinux Lib - Overview" +github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md" +migration_status: "new" +migration_source: "" +migration_issue: "" +migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" +migration_approved: false +github_org: gardenlinux +github_repo: python-gardenlinux-lib +github_source_path: docs/overview/index.md +--- + # Garden Linux Python Library Documentation Welcome to the Garden Linux Python Library documentation. This library provides @@ -23,7 +36,7 @@ interacting with Garden Linux components. It includes: ### Command-Line Interface The library provides several command-line tools for common operations. See the -[Command-Line Interface documentation](../reference/cli.md) for detailed +[Command-Line Interface documentation](../how-to/cli.md) for detailed information about all available commands. ### Release Management @@ -39,5 +52,5 @@ functions, see the ## Documentation Sections -- [Command-Line Interface](../reference/cli.md) +- [Command-Line Interface](../how-to/cli.md) - [Release documentation](../how-to/release.md) diff --git a/test-data/gardenlinux b/test-data/gardenlinux index 81d2743e..8c14e750 160000 --- a/test-data/gardenlinux +++ b/test-data/gardenlinux @@ -1 +1 @@ -Subproject commit 81d2743eed1d6d23e675033e7960734e32e8890d +Subproject commit 8c14e75011397cd6d16c1182f3377678c885b87a From 10eb691f409f057ac555b16bf1150918ba57f9ec Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Tue, 14 Apr 2026 08:52:40 +0200 Subject: [PATCH 3/6] docs: rename overview Signed-off-by: Eike Waldt On-behalf-of: SAP --- docs/overview/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/overview/index.md b/docs/overview/index.md index 99fdb903..781d360d 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,6 +1,6 @@ --- -title: "Python Gardenlinux Lib - Overview" -github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md" +title: "Python Library" +description: An overview of the Garden Linux Python Library migration_status: "new" migration_source: "" migration_issue: "" @@ -9,6 +9,7 @@ migration_approved: false github_org: gardenlinux github_repo: python-gardenlinux-lib github_source_path: docs/overview/index.md +github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md" --- # Garden Linux Python Library Documentation From 73a16adcc674e43ad9b811c399fa5af1b698d62f Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Tue, 14 Apr 2026 13:45:51 +0200 Subject: [PATCH 4/6] docs: restructure diataxis and aggregation Signed-off-by: Eike Waldt On-behalf-of: SAP --- docs/how-to/cli.md | 91 ------------------------------------------ docs/how-to/release.md | 16 ++++++-- docs/overview/index.md | 17 ++++---- docs/reference/cli.md | 72 +++++++++++++++++++++++++++++++++ 4 files changed, 93 insertions(+), 103 deletions(-) delete mode 100644 docs/how-to/cli.md create mode 100644 docs/reference/cli.md diff --git a/docs/how-to/cli.md b/docs/how-to/cli.md deleted file mode 100644 index 959ca900..00000000 --- a/docs/how-to/cli.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "Python Gardenlinux Lib - CLI" -github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/cli.md" -migration_status: "new" -migration_source: "" -migration_issue: "" -migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" -migration_approved: false -github_org: gardenlinux -github_repo: python-gardenlinux-lib -github_source_path: docs/how-to/cli.md ---- - -# Command-Line Interface - -This page documents all available command-line tools provided by -python-gardenlinux-lib. Run `command --help` for detailed usage information. - -## Features Commands - -### gl-cname - -Generate a canonical name (cname) from feature sets. - -```bash -gl-cname [options] -``` - -### gl-features-parse - -Parse and extract information from GardenLinux features. - -```bash -gl-features-parse [options] -``` - -## Flavors Commands - -### gl-flavors-parse - -Parse flavors.yaml and generate combinations. - -```bash -gl-flavors-parse [options] -``` - -## OCI Commands - -### gl-oci - -Push OCI artifacts to a registry and manage manifests. - -```bash -gl-oci [command] [options] -``` - -Commands: - -- `push` - Push OCI artifacts to a registry -- `manifest` - Manage OCI manifests - -## S3 Commands - -### gl-s3 - -Upload and download artifacts from S3 buckets. - -```bash -gl-s3 [command] [options] -``` - -Commands: - -- `upload` - Upload artifacts to S3 -- `download` - Download artifacts from S3 - -## GitHub Commands - -### gl-gh-release - -Create and manage GitHub releases. - -```bash -gl-gh-release [command] [options] -``` - -Commands: - -- `create` - Create a new release -- `update` - Update an existing release -- `list` - List all releases diff --git a/docs/how-to/release.md b/docs/how-to/release.md index b7c7bd30..2cea3133 100644 --- a/docs/how-to/release.md +++ b/docs/how-to/release.md @@ -1,6 +1,10 @@ --- -title: "Python Gardenlinux Lib - Release Process" -github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/how-to/release.md" +title: Release Process - Python Library +description: Release a new version of the Garden Linux Python Library +related_topics: + - /reference/supporting_tools/python-gardenlinux-lib.md + - /reference/python-gardenlinux-lib-cli.md + - /how-to/python-gardenlinux-lib-release.md migration_status: "new" migration_source: "" migration_issue: "" @@ -9,6 +13,7 @@ migration_approved: false github_org: gardenlinux github_repo: python-gardenlinux-lib github_source_path: docs/how-to/release.md +github_target_path: docs/how-to/python-gardenlinux-lib-release.md --- # Release Documentation @@ -29,12 +34,10 @@ command line. 1. **Set version files:** _python-gardenlinux-lib_ versioning needs to be set in: - - `pyproject.toml` - `.github/actions/setup/action.yml` Additionally at the moment (removal pending): - - `.github/actions/features_parse/action.yml` - `.github/actions/flavors_parse/action.yml` @@ -59,6 +62,11 @@ command line. ``` Or in `requirements.txt`: + ``` gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 ``` + +## Related Topics + + diff --git a/docs/overview/index.md b/docs/overview/index.md index 781d360d..4e02b2ca 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -1,6 +1,10 @@ --- title: "Python Library" description: An overview of the Garden Linux Python Library +related_topics: + - /reference/supporting_tools/python-gardenlinux-lib.md + - /reference/python-gardenlinux-lib-cli.md + - /how-to/python-gardenlinux-lib-release.md migration_status: "new" migration_source: "" migration_issue: "" @@ -9,7 +13,7 @@ migration_approved: false github_org: gardenlinux github_repo: python-gardenlinux-lib github_source_path: docs/overview/index.md -github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib/overview/index.md" +github_target_path: "docs/reference/supporting_tools/python-gardenlinux-lib.md" --- # Garden Linux Python Library Documentation @@ -18,8 +22,6 @@ Welcome to the Garden Linux Python Library documentation. This library provides Python tools and utilities for working with Garden Linux features, flavors, OCI artifacts, S3 buckets, and GitHub releases. -![Garden Linux Logo](../_static/gardenlinux-logo.svg) - ## Overview The Garden Linux Python Library is a comprehensive toolkit for managing and @@ -37,13 +39,13 @@ interacting with Garden Linux components. It includes: ### Command-Line Interface The library provides several command-line tools for common operations. See the -[Command-Line Interface documentation](../how-to/cli.md) for detailed +[Command-Line Interface documentation](/reference/python-gardenlinux-lib-cli.md) for detailed information about all available commands. ### Release Management For information about versioning and release procedures, see the -[Release documentation](../how-to/release.md). +[Release documentation](/how-to/python-gardenlinux-lib-release.md). ### API Reference @@ -51,7 +53,6 @@ For detailed Python API documentation, including all modules, classes, and functions, see the [API Reference on ReadTheDocs](https://gardenlinux.github.io/python-gardenlinux-lib/api.html). -## Documentation Sections +## Related Topics -- [Command-Line Interface](../how-to/cli.md) -- [Release documentation](../how-to/release.md) + diff --git a/docs/reference/cli.md b/docs/reference/cli.md new file mode 100644 index 00000000..d43e5191 --- /dev/null +++ b/docs/reference/cli.md @@ -0,0 +1,72 @@ +--- +title: Command-Line Interface - Python Library +description: Command-Line Interface of the Garden Linux Python Library +related_topics: + - /reference/supporting_tools/python-gardenlinux-lib.md + - /reference/python-gardenlinux-lib-cli.md + - /how-to/python-gardenlinux-lib-release.md +migration_status: "new" +migration_source: "" +migration_issue: "" +migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" +migration_approved: false +github_org: gardenlinux +github_repo: python-gardenlinux-lib +github_source_path: docs/reference/cli.md +github_target_path: docs/reference/python-gardenlinux-lib-cli.md +--- + +# Documentation + +_python-gardenlinux-lib_ strictly follows the syntax and intention of +[Semantic Versioning](https://www.semver.org). Each release reflects the +intention and expected impact therefore. + +A new release is done by tagging a commit with a valid version. This will create +a GitHub pre-release for proof-reading. Once done a new release can be published +using GitHub CLI or UI. + +Newly added docstrings should contain the first version supporting the new API / +command line. + +## Step by Step Guide + +1. **Set version files:** + + _python-gardenlinux-lib_ versioning needs to be set in: + - `pyproject.toml` + - `.github/actions/setup/action.yml` + + Additionally at the moment (removal pending): + - `.github/actions/features_parse/action.yml` + - `.github/actions/flavors_parse/action.yml` + +2. **Create git tag:** + + ```bash + git tag + ``` + +3. **Review and publish:** + + Review the generated pre-release changelog by visiting the GitHub project + release page and publish it if applicable. + +4. **Consume the library:** + + Projects consuming the _python-gardenlinux-lib_ may use the following git URL + for dependency definition: + + ```bash + pip install git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 + ``` + + Or in `requirements.txt`: + + ``` + gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 + ``` + +## Related Topics + + From 86c57e91171a2b64680be06606f5cfe28abcb5ca Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Wed, 6 May 2026 14:36:52 +0200 Subject: [PATCH 5/6] docs: enable markdown docs Signed-off-by: Eike Waldt On-behalf-of: SAP --- docs/Makefile | 6 +++- docs/api.rst | 22 ++++++++++--- docs/cli.rst | 6 ++-- docs/conf.py | 7 ++++ docs/how-to/release.md | 8 ++--- docs/index.rst | 4 +-- docs/overview/index.md | 6 ++-- docs/reference/cli.md | 72 ------------------------------------------ pyproject.toml | 1 + 9 files changed, 42 insertions(+), 90 deletions(-) delete mode 100644 docs/reference/cli.md diff --git a/docs/Makefile b/docs/Makefile index d4bb2cbb..c8ea8e0a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,7 +12,11 @@ BUILDDIR = _build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +.PHONY: help markdown Makefile + +# Explicit markdown target: build Markdown output via sphinx-markdown-builder +markdown: + @$(SPHINXBUILD) -M markdown "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/docs/api.rst b/docs/api.rst index 2d68330a..8598052f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,22 +1,34 @@ -API Reference -============= +Python Library - API Reference +============================== -This section provides detailed documentation for all Python modules and classes in python-gardenlinux-lib. +Detailed documentation for all Python modules and classes in the Garden Linux Python Library -.. automodule:: gardenlinux - :members: +gardenlinux.apt +~~~~~~~~~~~~~~~ .. automodule:: gardenlinux.apt :members: +gardenlinux.features +~~~~~~~~~~~~~~~~~~~~ + .. automodule:: gardenlinux.features :members: +gardenlinux.flavors +~~~~~~~~~~~~~~~~~~~ + .. automodule:: gardenlinux.flavors :members: +gardenlinux.git +~~~~~~~~~~~~~~~ + .. automodule:: gardenlinux.git :members: +gardenlinux.oci +~~~~~~~~~~~~~~~ + .. automodule:: gardenlinux.oci :members: diff --git a/docs/cli.rst b/docs/cli.rst index 80cc963c..f975b2aa 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -1,7 +1,7 @@ -Command-Line Interface -====================== +Python Library - Command-Line Interface +======================================= -This page documents all available command-line tools provided by python-gardenlinux-lib. +Available command-line tools provided by the Garden Linux Python Library Features Commands ----------------- diff --git a/docs/conf.py b/docs/conf.py index 30c97c2f..a24c6f5f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,8 +22,15 @@ "sphinx.ext.napoleon", "sphinx_click", "sphinxcontrib.autoprogram", + "sphinx_markdown_builder", ] +# Markdown builder configuration (GitHub-Flavored Markdown for VitePress) +# We can enable this after https://github.com/liran-funaro/sphinx-markdown-builder/pull/53 is merged +# markdown_flavor = "github" +markdown_anchor_sections = True +markdown_anchor_signatures = True + templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] autodoc_mock_imports = ["networkx"] diff --git a/docs/how-to/release.md b/docs/how-to/release.md index 2cea3133..82c74838 100644 --- a/docs/how-to/release.md +++ b/docs/how-to/release.md @@ -1,10 +1,10 @@ --- -title: Release Process - Python Library +title: Python Library - Release Process description: Release a new version of the Garden Linux Python Library related_topics: - - /reference/supporting_tools/python-gardenlinux-lib.md - - /reference/python-gardenlinux-lib-cli.md - - /how-to/python-gardenlinux-lib-release.md + - /reference/supporting_tools/python-gardenlinux-lib + - /reference/python-gardenlinux-lib-cli + - /how-to/python-gardenlinux-lib-release migration_status: "new" migration_source: "" migration_issue: "" diff --git a/docs/index.rst b/docs/index.rst index 9de35821..547111d6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ -Garden Linux Python Library Documentation +Garden Linux Python Library ========================================== -Welcome to the Garden Linux Python Library documentation. This library provides +The Garden linux Python Library provides Python tools and utilities for working with Garden Linux features, flavors, OCI artifacts, S3 buckets, and GitHub releases. diff --git a/docs/overview/index.md b/docs/overview/index.md index 4e02b2ca..08d5cdeb 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -2,9 +2,9 @@ title: "Python Library" description: An overview of the Garden Linux Python Library related_topics: - - /reference/supporting_tools/python-gardenlinux-lib.md - - /reference/python-gardenlinux-lib-cli.md - - /how-to/python-gardenlinux-lib-release.md + - /reference/supporting_tools/python-gardenlinux-lib + - /reference/python-gardenlinux-lib-cli + - /how-to/python-gardenlinux-lib-release migration_status: "new" migration_source: "" migration_issue: "" diff --git a/docs/reference/cli.md b/docs/reference/cli.md deleted file mode 100644 index d43e5191..00000000 --- a/docs/reference/cli.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Command-Line Interface - Python Library -description: Command-Line Interface of the Garden Linux Python Library -related_topics: - - /reference/supporting_tools/python-gardenlinux-lib.md - - /reference/python-gardenlinux-lib-cli.md - - /how-to/python-gardenlinux-lib-release.md -migration_status: "new" -migration_source: "" -migration_issue: "" -migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" -migration_approved: false -github_org: gardenlinux -github_repo: python-gardenlinux-lib -github_source_path: docs/reference/cli.md -github_target_path: docs/reference/python-gardenlinux-lib-cli.md ---- - -# Documentation - -_python-gardenlinux-lib_ strictly follows the syntax and intention of -[Semantic Versioning](https://www.semver.org). Each release reflects the -intention and expected impact therefore. - -A new release is done by tagging a commit with a valid version. This will create -a GitHub pre-release for proof-reading. Once done a new release can be published -using GitHub CLI or UI. - -Newly added docstrings should contain the first version supporting the new API / -command line. - -## Step by Step Guide - -1. **Set version files:** - - _python-gardenlinux-lib_ versioning needs to be set in: - - `pyproject.toml` - - `.github/actions/setup/action.yml` - - Additionally at the moment (removal pending): - - `.github/actions/features_parse/action.yml` - - `.github/actions/flavors_parse/action.yml` - -2. **Create git tag:** - - ```bash - git tag - ``` - -3. **Review and publish:** - - Review the generated pre-release changelog by visiting the GitHub project - release page and publish it if applicable. - -4. **Consume the library:** - - Projects consuming the _python-gardenlinux-lib_ may use the following git URL - for dependency definition: - - ```bash - pip install git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 - ``` - - Or in `requirements.txt`: - - ``` - gardenlinux @ git+https://github.com/gardenlinux/python-gardenlinux-lib.git@1.0.0 - ``` - -## Related Topics - - diff --git a/pyproject.toml b/pyproject.toml index efa07c38..7364c388 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,6 +42,7 @@ boto3-stubs = { extras = ["s3"], version = "^1.42.30" } sphinx-rtd-theme = "^3.0.2" sphinx-click = "^4.4.0" sphinxcontrib-autoprogram = "^0.1.8" +sphinx-markdown-builder = "^0.6.10" [tool.poetry.scripts] gl-cname = "gardenlinux.features.cname_main:main" From 995886a39a0ca93e9710a97acb3995dc93c99c87 Mon Sep 17 00:00:00 2001 From: Eike Waldt Date: Tue, 12 May 2026 12:17:20 +0200 Subject: [PATCH 6/6] docs: update migration status Signed-off-by: Eike Waldt On-behalf-of: SAP --- docs/how-to/release.md | 4 +--- docs/overview/index.md | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/how-to/release.md b/docs/how-to/release.md index 82c74838..00eb70a7 100644 --- a/docs/how-to/release.md +++ b/docs/how-to/release.md @@ -5,9 +5,7 @@ related_topics: - /reference/supporting_tools/python-gardenlinux-lib - /reference/python-gardenlinux-lib-cli - /how-to/python-gardenlinux-lib-release -migration_status: "new" -migration_source: "" -migration_issue: "" +migration_status: "done" migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" migration_approved: false github_org: gardenlinux diff --git a/docs/overview/index.md b/docs/overview/index.md index 08d5cdeb..c6b8b124 100644 --- a/docs/overview/index.md +++ b/docs/overview/index.md @@ -5,9 +5,7 @@ related_topics: - /reference/supporting_tools/python-gardenlinux-lib - /reference/python-gardenlinux-lib-cli - /how-to/python-gardenlinux-lib-release -migration_status: "new" -migration_source: "" -migration_issue: "" +migration_status: "done" migration_stakeholder: "@tmangold, @yeoldegrove, @ByteOtter" migration_approved: false github_org: gardenlinux