Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add docs for zpages #48760

Merged
merged 2 commits into from
Nov 26, 2024
Merged

Add docs for zpages #48760

merged 2 commits into from
Nov 26, 2024
+98 −0

Conversation

richabanker
Copy link
Contributor

Description

Docs for Kubernetes z-pages

Issue

kubernetes/enhancements#4827
kubernetes/enhancements#4828

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 18, 2024
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 18, 2024
@richabanker richabanker mentioned this pull request Nov 18, 2024
Closed
@richabanker
Copy link
Contributor Author

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Nov 18, 2024
@netlify Netlify
Copy link

netlify bot commented Nov 19, 2024 •
edited
Loading

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 9b347d4
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6744b975bd7bde00088ae555
😎 Deploy Preview https://deploy-preview-48760--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 19, 2024
dipesh-rawat
dipesh-rawat reviewed Nov 19, 2024
View reviewed changes
Copy link
Member

@dipesh-rawat dipesh-rawat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@richabanker We should consider setting the dev-1.32 branch as the target branch rather than the main branch for this pull request. Since the change is related to the feature targeting v1.32 release.

This was referenced Nov 19, 2024
Open
Open
@richabanker richabanker changed the base branch from main to dev-1.32 November 19, 2024 00:30
@richabanker
Copy link
Contributor Author

@richabanker We should consider setting the dev-1.32 branch as the target branch rather than the main branch for this pull request. Since the change is related to the feature targeting v1.32 release.

Done

@netlify Netlify
Copy link

netlify bot commented Nov 19, 2024 •
edited
Loading

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 9b347d4
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6744b9756ae5ee00084e90cd

@richabanker richabanker force-pushed the zpages-docs branch 2 times, most recently from 8edc17f to c70813a Compare November 19, 2024 22:32
@rdalbuquerque
Copy link

Hello @richabanker and @kubernetes/sig-docs-en-owners 👋! I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on Tuesday November 26th 18:00 PDT. This documentation appears to still be under review. To meet the Docs Freeze, this PR must have a technical review as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs. Thank you!

sftim
sftim requested changes Nov 25, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, but: the feature gate definitions are missing.

content/en/docs/reference/command-line-tools-reference/feature-gates/component-flagz.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be empty.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed now, thanks

content/en/docs/reference/command-line-tools-reference/feature-gates/component-statusz.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be empty.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
content/en/docs/reference/instrumentation/zpages.md
Comment on lines +22 to +31
- [statusz](#statusz)
- [flagz](#flagz)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this right:

Suggested change
- [statusz](#statusz)
- [flagz](#flagz)
- [`/statusz`](#statusz)
- [`/flagz`](#flagz)

?

content/en/docs/reference/instrumentation/zpages.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 25, 2024
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 25, 2024
sftim
sftim previously requested changes Nov 25, 2024
View reviewed changes
content/en/docs/reference/instrumentation/zpages.md Outdated
Comment on lines 62 to 68
---
reviewers:
- dashpole
title: Kubernetes z-pages
content_type: reference
weight: 20
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The front matter needs to come first in the file; that's what Hugo expects.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah clearly misunderstood your previous comment. Tried to fix now, is this better?

@richabanker @sftim
Add docs for zpages
e8fdfaa 
Co-authored-by: Tim Bannister <tim@scalefactory.com>
@sftim
Copy link
Contributor

sftim commented Nov 25, 2024

BTW, for beta we should definitely document what access control looks like for these endpoints. Even if we think it's obvious, the people reading the docs might not agree.

@richabanker @sftim
Update content/en/docs/reference/instrumentation/zpages.md
9b347d4 
Co-authored-by: Tim Bannister <tim@scalefactory.com>
dashpole
dashpole approved these changes Nov 25, 2024
View reviewed changes
Copy link
Contributor

@dashpole dashpole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm for sig-instrumentation

@sftim sftim dismissed their stale review November 26, 2024 11:26

Issue fixed

@sftim
Copy link
Contributor

sftim commented Nov 26, 2024

k/k code is merged

Tech LGTM: #48760 (review)
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 26, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: d50560bdcc755b0172ff97be21ae7a62fc97d75b

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dashpole, sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 26, 2024
@k8s-ci-robot k8s-ci-robot merged commit 69cce03 into kubernetes:dev-1.32 Nov 26, 2024
6 checks passed
@k8s-ci-robot k8s-ci-robot added this to the 1.32 milestone Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@dipesh-rawat dipesh-rawat dipesh-rawat left review comments

@dashpole dashpole dashpole approved these changes

@tengqm tengqm Awaiting requested review from tengqm

@windsonsea windsonsea Awaiting requested review from windsonsea

Assignees

@sftim sftim

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
1.32
Development

Successfully merging this pull request may close these issues.
6 participants
@richabanker @rdalbuquerque @sftim @k8s-ci-robot @dashpole @dipesh-rawat