-
Notifications
You must be signed in to change notification settings - Fork 1
Docs: Rework Readme #348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ByteOtter
wants to merge
1
commit into
docs-ng
Choose a base branch
from
docs/new-readme
base: docs-ng
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Docs: Rework Readme #348
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,17 @@ | ||
| ## Garden Linux Python Library | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Garden Linux Python Library | ||
|
|
||
| Python tooling to work with [Garden Linux](https://github.com/gardenlinux/gardenlinux) features, flavors, OCI artifacts, repositories, and releases. | ||
| It is primarily targeted at Garden Linux developers and CI pipelines rather than end users. | ||
| Python tooling to work with | ||
| [Garden Linux](https://github.com/gardenlinux/gardenlinux) features, flavors, | ||
| OCI artifacts, repositories, and releases. It is primarily targeted at Garden | ||
| Linux developers and CI pipelines rather than end users. | ||
|
|
||
| The library follows the intent of [Semantic Versioning](https://semver.org) for its public APIs. | ||
| The library follows the intent of [Semantic Versioning](https://semver.org) for | ||
| its public APIs. | ||
|
|
||
| ### Features | ||
|
|
||
|
|
@@ -21,14 +24,11 @@ The library follows the intent of [Semantic Versioning](https://semver.org) for | |
|
|
||
| ## Documentation | ||
|
|
||
| Full documentation is available at the **Garden Linux Python Library Documentation** site: | ||
| [https://gardenlinux.github.io/python-gardenlinux-lib/](https://gardenlinux.github.io/python-gardenlinux-lib/) | ||
|
|
||
| The docs include: | ||
| You can find our full documentation for this python library on our | ||
| [Documentation Hub](https://gardenlinux-docs.netlify.app/reference/supporting_tools/python-gardenlinux-lib.html). | ||
|
|
||
| - **Command-Line Interface**: `gl-features-*`, `gl-flavors-*`, `gl-oci`, `gl-s3`, `gl-gh-release` | ||
| - **API Reference**: modules, classes, and functions (e.g. `Parser`, `CName`, `Container`, `Repository`) | ||
| - **Release documentation**: versioning and release process | ||
| For a detailed API documentation, check | ||
| [gardenlinux.github.io/python-gardenlinux-lib/api.html](https://gardenlinux.github.io/python-gardenlinux-lib/) | ||
|
|
||
| ## Installation | ||
|
|
||
|
|
@@ -72,7 +72,8 @@ for feature in feature_list: | |
| print(feature) | ||
| ``` | ||
|
|
||
| For more examples and for all CLI tools, see the **Command-Line Interface** and **API Reference** sections in the docs: | ||
| For more examples and for all CLI tools, see the **Command-Line Interface** and | ||
| **API Reference** sections in the docs: | ||
| [https://gardenlinux.github.io/python-gardenlinux-lib/](https://gardenlinux.github.io/python-gardenlinux-lib/) | ||
|
Comment on lines
+75
to
77
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Properly link to docs. |
||
|
|
||
| <p align="center"> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove the "installation" section and directly link the docs that explain it.