Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion README.md

This file was deleted.

61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Garden Linux Documentation Framework

`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.

## 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).

<p align="center">
<img alt="Bundesministerium für Wirtschaft und Energie (BMWE)-EU funding logo" src="https://apeirora.eu/assets/img/BMWK-EU.png" width="400"/>
</p>
2 changes: 1 addition & 1 deletion repos-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"docs_path": "docs",
"target_path": "projects/builder",
"ref": "docs-ng",
"commit": "b4ef334934f108f2aa1a2b3430a6d25a6dd89c26",
"commit": "fab0c1b98c37b682774bb815c674e178af9758ab",
"media_directories": [
".media",
"assets",
Expand Down
Loading