search

kubernetes-sigs / custom-metrics-apiserver

Framework for implementing custom metrics support for Kubernetes
Apache License 2.0
502 stars 176 forks source link

Synchronize test-adapter and Getting Started Guide #132

Closed olivierlemasle closed 4 months ago

olivierlemasle commented 1 year ago

Currently, the Getting Started Guide includes pieces of code which, combined, give a sample adapter, different from the test-adapter.

That leads to two issues:

To tackle the first issue, we could enforce the Markdown from Getting Started Guide to be synced with Go code (e.g. kube-prometheus uses mdox to check that Jsonnet examples from its Markdown documentation is synced with Jsonnet files - cf here).

Ideally, we would have a single test implementation (test-adapter). However, test-adapter is more complex than the implementation from the Getting Started Guide...

What do you think?

dashpole commented 1 year ago

/assign @olivierlemasle /triage accepted

olivierlemasle commented 1 year ago

/kind documentation

olivierlemasle commented 1 year ago

Created PR #138 to try this mdox solution.

It "solves" issue 1 (compiling / testing code snippets in documentation), but not issue 2 (having 2 test adapters).

However, I wonder if it's really an issue. The current "test-adapter" may be better suited for tests (end to end tests to be created, unit tests), and this "sample-adapter" is an entry-level example.

k8s-triage-robot commented 9 months ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

k8s-triage-robot commented 6 months ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 5 months ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot commented 4 months ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-ci-robot commented 4 months ago

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes-sigs/custom-metrics-apiserver/issues/132#issuecomment-2174714266): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages issues according to the following rules: >- After 90d of inactivity, `lifecycle/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was applied, the issue is closed > >You can: >- Reopen this issue with `/reopen` >- Mark this issue as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.