From 0da570f65a2bf6561868130ef3190719064a23f4 Mon Sep 17 00:00:00 2001 From: "Marlapati Venkata Naga Sai Teja[marlapativ]" Date: Fri, 26 Jul 2024 10:28:37 -0400 Subject: [PATCH 1/3] fix(markerdocs): reverting changes that broker markerdocs app build --- docs/book/utils/markerdocs/html.go | 6 ++---- docs/book/utils/markerdocs/main.go | 5 ++--- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/book/utils/markerdocs/html.go b/docs/book/utils/markerdocs/html.go index 2eea7a4bbb3..471d8a83b4f 100644 --- a/docs/book/utils/markerdocs/html.go +++ b/docs/book/utils/markerdocs/html.go @@ -77,8 +77,7 @@ func (t Tag) WriteHTML(w io.Writer) error { if t.Attrs != nil { attrsOut = t.Attrs.ToAttrs() } - if _, err := fmt.Fprintf((w, "<%s %s>", t.Name, attrsOut) - err != nil{ + if _, err := fmt.Fprintf(w, "<%s %s>", t.Name, attrsOut); err != nil { return err } @@ -88,8 +87,7 @@ func (t Tag) WriteHTML(w io.Writer) error { } } - if _, err := fmt.Fprintf((w, "", t.Name) - err != nil{ + if _, err := fmt.Fprintf(w, "", t.Name); err != nil { return err } diff --git a/docs/book/utils/markerdocs/main.go b/docs/book/utils/markerdocs/main.go index 81758e6cde7..afdd600cf3c 100644 --- a/docs/book/utils/markerdocs/main.go +++ b/docs/book/utils/markerdocs/main.go @@ -164,7 +164,7 @@ func (p MarkerDocs) Process(input *plugin.Input) error { content := new(strings.Builder) // NB(directxman12): wrap this in a div to prevent the markdown processor from inserting extra paragraphs - _, err := fmt.Fprintf((content, "
", categoryAlias) + _, err := fmt.Fprintf(content, "
", categoryAlias) if err != nil { return "", fmt.Errorf("unable to render marker documentation summary: %v", err) } @@ -176,8 +176,7 @@ func (p MarkerDocs) Process(input *plugin.Input) error { } } - if _, err = _, _ = fmt.Fprintf(content, "
") - err != nil{ + if _, err = fmt.Fprintf(content, "
"); err != nil { return "", fmt.Errorf("unable to render marker documentation: %v", err) } From 3ccb2619085ebeef3427e222fa8ad5cf35db15f1 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Thu, 21 Nov 2024 17:03:24 +0000 Subject: [PATCH 2/3] :book: Update metrics.md - Update the docs to provide more clarity --- docs/book/src/reference/metrics.md | 34 ++++++++++++------------------ 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/docs/book/src/reference/metrics.md b/docs/book/src/reference/metrics.md index 763f482c519..9f28bc77252 100644 --- a/docs/book/src/reference/metrics.md +++ b/docs/book/src/reference/metrics.md @@ -1,37 +1,31 @@ # Metrics -By default, controller-runtime builds a global prometheus registry and +By default, controller-runtime builds a global Prometheus registry and publishes [a collection of performance metrics](/reference/metrics-reference.md) for each controller. + ## Metrics Configuration By looking at the file `config/default/kustomization.yaml` you can @@ -302,4 +296,4 @@ In order to publish metrics and view them on the Prometheus UI, the Prometheus i Those metrics will be available for prometheus or other openmetrics systems to scrape. -![Screen Shot 2021-06-14 at 10 15 59 AM](https://user-images.githubusercontent.com/37827279/121932262-8843cd80-ccf9-11eb-9c8e-98d0eda80169.png) \ No newline at end of file +![Screen Shot 2021-06-14 at 10 15 59 AM](https://user-images.githubusercontent.com/37827279/121932262-8843cd80-ccf9-11eb-9c8e-98d0eda80169.png) From f7f8bbe1dacbbd4d2b8fe851354d18fd6a666bc6 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Fri, 22 Nov 2024 21:49:49 +0000 Subject: [PATCH 3/3] :book:book: centralize metrics documentation messaging for consistency with updates --- docs/book/src/reference/metrics.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/book/src/reference/metrics.md b/docs/book/src/reference/metrics.md index 9f28bc77252..a73f2048bda 100644 --- a/docs/book/src/reference/metrics.md +++ b/docs/book/src/reference/metrics.md @@ -20,7 +20,6 @@ enabled by default via Controller-Runtime's feature [WithAuthenticationAndAuthor If you want to continue using [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) then you MUST change your project to use the image from another source. -> This infrastructure is outside of our control, we cannot guarantee any timeline or any extensions. > For further information, see: [kubebuilder/discussions/3907](https://github.com/kubernetes-sigs/kubebuilder/discussions/3907)