From 068909ccb9b3cb1d403be0ebda9f990c6c59fe53 Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Tue, 26 May 2026 12:43:00 +0200 Subject: [PATCH 1/3] Docs: Rework Readme Signed-off-by: Tiara Lena Hock --- README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) mode change 120000 => 100644 README.md diff --git a/README.md b/README.md deleted file mode 120000 index ec3024d..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/contributing/documentation/working-locally.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..092c6ca --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# Garden Linux Documentation Framework + +`docs-ng` is the primary documentation aggregation framework and hosting hub. + +This repository contains all source code of our custom aggregation system, as +well as any relevant documentation related to the topic of documenting. + +If you are looking for documentation of a specific project within the Garden +Linux organization, check the `docs/` directory in the repository you are +looking for using the search function or the hosted website at +https://gardenlinux-docs.netlify.app. + +## Documentation + +To learn everything related to our approach of documenting, check the +[Documentation](https://gardenlinux-docs.netlify.app/contributing/documentation/) +subsection of our contributing page. + +You can also jump directly into topics like +[how to work with the documentation system locally](https://gardenlinux-docs.netlify.app/contributing/documentation/working-locally.html), +[our documentation workflow & review process](https://gardenlinux-docs.netlify.app/contributing/documentation/documentation_workflow.html) +and the +[quality markers](https://gardenlinux-docs.netlify.app/contributing/documentation/writing_good_docs.html) +we use to verify the quality of contributed documentation. + +While browsing our docs, if you find something that you would like to correct or +improve on a specific page, the `Edit this page on GitHub` button at the bottom +of the page takes you directly to the correct file in GitHub. We appreciate your +contribution! + +## Community + +To stay up-to-date with recent news about Gardenlinux, subscribe to our mailing +list: + +https://lists.neonephos.org/g/gardenlinux-discussion + +For updates and statements regarding security issues, we have a security mailing +list for you: + +https://lists.neonephos.org/g/gardenlinux-security + +For embargoed security related topics, this list is for you: + +https://lists.neonephos.org/g/gardenlinux-security-embargo + +## Contributing + +We welcome your contributions to Gardenlinux or any supporting projects. + +To find out more, visit our +[Contributor Documentation](https://gardenlinux-docs.netlify.app/contributing). + +## Licensing + +Copyright 2025 SAP SE or an SAP affiliate company and GardenLinux contributors. +Please see our [LICENSE](LICENSE.md) for copyright and license information. +Detailed information including third-party components and their +licensing/copyright information is available +[via the REUSE tool](https://reuse.software). + +

+ Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo +

From 230c5715ed01686e28f7aa685dd3a443940c4d09 Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Tue, 26 May 2026 15:15:46 +0200 Subject: [PATCH 2/3] Docs: Directly link to landing page and remove mention of docs directories Signed-off-by: Tiara Lena Hock --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 092c6ca..67cbc15 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,11 @@ `docs-ng` is the primary documentation aggregation framework and hosting hub. +The documentation is hosted at https://gardenlinux-docs.netlify.app + This repository contains all source code of our custom aggregation system, as well as any relevant documentation related to the topic of documenting. -If you are looking for documentation of a specific project within the Garden -Linux organization, check the `docs/` directory in the repository you are -looking for using the search function or the hosted website at -https://gardenlinux-docs.netlify.app. - ## Documentation To learn everything related to our approach of documenting, check the From 05221b79c69e2fe632368a770ac1a37d7651217b Mon Sep 17 00:00:00 2001 From: Tiara Lena Hock Date: Tue, 26 May 2026 16:05:17 +0200 Subject: [PATCH 3/3] Docs: Update aggregate commits Signed-off-by: Tiara Lena Hock --- repos-config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/repos-config.json b/repos-config.json index c9f6020..7cf9c45 100644 --- a/repos-config.json +++ b/repos-config.json @@ -32,7 +32,7 @@ "docs_path": "docs", "target_path": "projects/builder", "ref": "docs-ng", - "commit": "b4ef334934f108f2aa1a2b3430a6d25a6dd89c26", + "commit": "fab0c1b98c37b682774bb815c674e178af9758ab", "media_directories": [ ".media", "assets",