Helm SDK doc section and examples #1543
Conversation
gjenkins8
force-pushed
the
sdkexamples
branch
from
b7ae14d
to
fb92f43
Compare
Signed-off-by: George Jenkins <[email protected]>
Signed-off-by: George Jenkins <[email protected]>
Signed-off-by: George Jenkins <[email protected]>
gjenkins8
force-pushed
the
sdkexamples
branch
from
fb92f43
to
ebcc86d
Compare
| @@ -0,0 +1,144 @@ | |||
| module github.com/helm/helm-www/sdkexamples | |||
There was a problem hiding this comment.
I put the source in this 'sdkexamples' directory. As this directory / the source is meant to be a standalone, buildable go project. Suggestions on how to better structure this welcome
Signed-off-by: George Jenkins <[email protected]>
Signed-off-by: George Jenkins <[email protected]>
|
Will this be merged? |
|
Please add |
There was a problem hiding this comment.
@gjenkins8 this all looks great! 👏 Just a few requested changes.
Would you also:
- ensure the code is up to date (given that it took me 10 months to review)?
- rebase from main (to make sure we don't plow over any changes that may have been made since then for things like navigation weights, etc)?
| @@ -0,0 +1 @@ | |||
| {{ transform.Highlight (os.ReadFile (.Get "file")) "go" }} | |||
There was a problem hiding this comment.
small Git nit, needs newline at EOF
| aliases: ["/docs/gosdk"] | ||
| weight: 1 | ||
| --- | ||
| Helm's Go SDK enables custom software to leverage Helm charts and Helm's functionality for managing Kubernetes software deployment (In fact, the Helm CLI is effectively just one such tool!) |
There was a problem hiding this comment.
I think we should integrate with this existing Go SDK section under Advanced Helm Techniques https://helm.sh/docs/topics/advanced/#go-sdk
| Helm's Go SDK enables custom software to leverage Helm charts and Helm's functionality for managing Kubernetes software deployment (In fact, the Helm CLI is effectively just one such tool!) | ||
|
|
||
| Currently, the SDK has been functionally separated from the Helm CLI, and the SDK can (and is) used by standalone tooling. The Helm project has committed to API stability for the SDK. As a warning, the SDK has some rough edges remaining from the initial work to separate the CLI and the SDK. Which the Helm project aims to improve and over time. | ||
|
|
There was a problem hiding this comment.
may be good to link to the examples page from here. Especially for mobile users—or any user who landed here from a web search—who may not see the examples page in the left navigation.
| See [Go SDK Examples]({{< ref "../examples" >}}) for fully working code examples. | |
Create a docs section for the SDK. With a (brief) description of the SDK, and some examples
(the main intent of the PR is to add SDK examples)