website icon indicating copy to clipboard operation
website copied to clipboard

Update hello-minikube.md

Open cjcullen opened this issue 9 months ago • 2 comments

Add warning about kubectl expose on agnhost

cjcullen avatar May 02 '24 17:05 cjcullen

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign tengqm for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 avatar May 02 '24 17:05 k8s-ci-robot

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit a3e1fef3a04fdd8addffc7139de2c1b4f53d3702
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/667da4b1c28bdc00083389cb
Deploy Preview https://deploy-preview-46140--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.

netlify[bot] avatar May 02 '24 17:05 netlify[bot]

@cjcullen Whenever you get a chance, could you please take a look at the reviewers' feedback and respond to them? Thanks!

dipesh-rawat avatar May 25 '24 00:05 dipesh-rawat

@cjcullen would you be willing to wrap the warning per the feedback in https://github.com/kubernetes/website/pull/46140/files#r1588795257 ?

@sftim - I've a question. If the suggestion is to wrap the lines then how come at lines 146 to 148, the same is not done for note or for that matter anywhere else?

{{< note >}} Replace hello-node-5f76cf6ccf-br9b5 in the kubectl logs command with the name of the pod from the kubectl get pods command output. {{< /note >}}

sandeepkanabar avatar Jun 20 '24 10:06 sandeepkanabar

If the suggestion is to wrap the lines then how come at lines 146 to 148, the same is not done for note or for that matter anywhere else?

The convention, in general, is to treat markdown documentation as code, where we value not only how the output looks like, but also the readability of the source. The suggestion as I see it is not a blocker. Another example is the wrapping of long lines in ".md" files. These wrapping would not affect the rendered web pages, but manual wrapping of long lines help improve readability, and it helps tracking changes on a line-by-line basis (that is how git diff works), and it helps the downstream localization team to track upstream changes.

tengqm avatar Jun 20 '24 11:06 tengqm

If the suggestion is to wrap the lines then how come at lines 146 to 148, the same is not done for note or for that matter anywhere else?

The convention, in general, is to treat markdown documentation as code, where we value not only how the output looks like, but also the readability of the source. The suggestion as I see it is not a blocker. Another example is the wrapping of long lines in ".md" files. These wrapping would not affect the rendered web pages, but manual wrapping of long lines help improve readability, and it helps tracking changes on a line-by-line basis (that is how git diff works), and it helps the downstream localization team to track upstream changes.

Thanks for such an excellent clarification, Qiming 🙏🏻

sandeepkanabar avatar Jun 20 '24 14:06 sandeepkanabar

The changes look good to me. https://deploy-preview-46140--kubernetes-io-main-staging.netlify.app/docs/tutorials/hello-minikube/#create-a-service /lgtm

Shubham82 avatar Jun 28 '24 11:06 Shubham82

LGTM label has been added.

Git tree hash: 0bdf2d1c9af48d3b3704811c9c35c300238139f1

k8s-ci-robot avatar Jun 28 '24 11:06 k8s-ci-robot

@cjcullen updated the PR, so we can approve this PR, as it was opened first.

CC @sftim @dipesh-rawat WDYT?

Shubham82 avatar Jun 28 '24 11:06 Shubham82

/lgtm

stmcginnis avatar Jun 28 '24 11:06 stmcginnis

Thanks for this @cjcullen /approve

nate-double-u avatar Jul 10 '24 15:07 nate-double-u

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nate-double-u, sandeepkanabar

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 avatar Jul 10 '24 15:07 k8s-ci-robot