Move kubectl overview to be section index #29847

sftim · 2021-09-28T17:54:07Z

Old page (also see its parent)
New page

Also:

use glossary definition in page introduction
tidy broken link in What's Next section
redirect old URL to new URL

/sig cli
/language en
/kind cleanup

netlify · 2021-09-28T18:08:07Z

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: 77a598c

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/62209391ca15f200086a5a23

😎 Browse the preview: https://deploy-preview-29847--kubernetes-io-main-staging.netlify.app

sftim · 2021-10-02T16:42:03Z

An enabling change for #25943

mkorbi · 2021-10-21T08:19:47Z

content/en/docs/reference/glossary/kubectl.md

@@ -4,16 +4,19 @@ id: kubectl
 date: 2018-04-12
 full_link: /docs/user-guide/kubectl-overview/
 short_description: >
-  A command line tool for communicating with a Kubernetes API server.
+  A command line tool for communicating with a Kubernetes cluster.


A command line tool for communicating with a Kubernetes cluster API server.

for me both is right depending on the target group

This is the tooltip text, shown when you hover. You can always click on the tooltip to learn more. I think this text is right for a tooltip.

Calling out, "Kubernetes API server" seems more specific than "cluster". Is it more important to identify the Kubernetes API server?

Here's why I prefer “cluster”: if we say “API server” in the tooltip, I'm worried that some newcomers will feel that they need to learn what a Kubernetes API server is—not an easy thing to grasp—and that some proportion of those will just write off Kubernetes as too hard to learn.

The full description is welcome to make the details clear.

mkorbi · 2021-10-21T08:29:44Z

content/en/docs/reference/kubectl/_index.md

+## {{% heading "whatsnext" %}}
+
+* Read the `kubectl` [command reference](/docs/reference/kubectl/kubectl/).
+


Find some further useful command examples on the kubectl cheat sheet

maybe useful to add

I usually prefer to keep migration PRs separate from PRs that add new content.

sftim · 2021-10-26T13:11:02Z

@mkorbi have I convinced you that we can accept these changes as-is? Happy to discuss further.

jimangel · 2021-12-06T01:44:28Z

/lgtm

I wonder if this should land after the release and if we need to boost visibility to localization (to me it feels like a small big change vs. a refactor)?

k8s-ci-robot · 2021-12-06T01:44:47Z

LGTM label has been added.

Git tree hash: 7c71f4302318adc08eff1480816accd0c088dbee

sftim · 2021-12-06T10:23:12Z

Happy to let this land after the v1.23 release and yes, we should consider applying the refactor label.
/label refactor

sftim · 2022-01-05T21:46:43Z

@jimangel the only changes since your previous LGTM were a (quite big) rebase with no manual rework

kbhawkey · 2022-02-27T16:37:15Z

content/en/docs/reference/kubectl/_index.md

+## {{% heading "whatsnext" %}}
+
+* Read the `kubectl` [command reference](/docs/reference/kubectl/kubectl/).
+* Read the `kubectl` [command line arguments](/docs/reference/kubectl/kubectl/) reference.


👋 @sftim, Can you check the links for the first two items (links are the same)?
The page could be configured to ignore the list of section links at the bottom of the page, or do you think the links add value?

kbhawkey · 2022-02-27T16:42:44Z

content/en/docs/reference/kubectl/_index.md

@@ -1,5 +1,551 @@
 ---
-title: "kubectl"
+title: Command line tool (kubectl)


nit: Should the title contain Kubernetes?
Kubernetes command-line tool (kubectl)

@kbhawkey let's save that for a different PR; that would be a change beyond the page move that this PR's title covers.

Also: - use glossary definition in page introduction - tidy broken link in What's Next section - update links to refer to moved page

Also, reorder the section overall.

kbhawkey · 2022-03-05T21:51:50Z

/approve

k8s-ci-robot · 2022-03-05T21:52:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kbhawkey

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:

~~OWNERS~~ [kbhawkey]

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

kbhawkey · 2022-03-05T21:53:04Z

/lgtm

k8s-ci-robot · 2022-03-05T21:53:22Z

LGTM label has been added.

Git tree hash: f2f96258cb8f54c401590ed95201140accd6faa3

k8s-ci-robot requested review from bradtopol and tengqm September 28, 2021 17:55

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Sep 28, 2021

sftim marked this pull request as ready for review October 2, 2021 16:41

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 2, 2021

sftim force-pushed the 20210928_migrate_kubectl_overview branch from 168b095 to dafeaa1 Compare October 7, 2021 09:19

mkorbi reviewed Oct 21, 2021

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 25, 2021

sftim force-pushed the 20210928_migrate_kubectl_overview branch from dafeaa1 to 9690fda Compare December 5, 2021 23:02

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 5, 2021

sftim force-pushed the 20210928_migrate_kubectl_overview branch from cc29133 to fee70f0 Compare December 5, 2021 23:10

k8s-ci-robot assigned jimangel Dec 6, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 6, 2021

k8s-ci-robot added the refactor Indicates a PR with large refactoring changes e.g. removes files or moves content label Dec 6, 2021

sftim force-pushed the 20210928_migrate_kubectl_overview branch from fee70f0 to a6ebe69 Compare December 8, 2021 02:01

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 8, 2021

kbhawkey reviewed Feb 27, 2022

View reviewed changes

sftim added 3 commits March 3, 2022 10:03

Move kubectl overview to be section index

73cd38c

Also: - use glossary definition in page introduction - tidy broken link in What's Next section - update links to refer to moved page

Highlight link to kubectl cheat sheet

e0d4b37

Also, reorder the section overall.

Use in-page “what's next” list for kubectl

77a598c

sftim force-pushed the 20210928_migrate_kubectl_overview branch from f8c79a0 to 77a598c Compare March 3, 2022 10:08

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 5, 2022

k8s-ci-robot assigned kbhawkey Mar 5, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 5, 2022

k8s-ci-robot merged commit 3bcb656 into kubernetes:main Mar 5, 2022

Sea-n mentioned this pull request May 24, 2022

[zh] Move kubectl overview to be section index #33917

Merged

t-inu mentioned this pull request Dec 14, 2022

[ja] Update content/ja/docs/tasks/debug/_index.md #38466

Merged

This was referenced Mar 3, 2023

[ja] Update page weights under content/ja/docs/reference. #39771

Merged

[ja] Remove content/ja/docs/reference/kubectl/overview.md #39849

Merged

sftim deleted the 20210928_migrate_kubectl_overview branch September 23, 2023 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move kubectl overview to be section index #29847

Move kubectl overview to be section index #29847

sftim commented Sep 28, 2021 •

edited

Loading

netlify bot commented Sep 28, 2021 •

edited

Loading

sftim commented Oct 2, 2021

mkorbi Oct 21, 2021

mkorbi Oct 21, 2021

sftim Oct 21, 2021

kbhawkey Feb 27, 2022

sftim Feb 27, 2022

mkorbi Oct 21, 2021

mkorbi Oct 21, 2021

sftim Oct 21, 2021

sftim commented Oct 26, 2021

jimangel commented Dec 6, 2021

k8s-ci-robot commented Dec 6, 2021

sftim commented Dec 6, 2021

sftim commented Jan 5, 2022

kbhawkey Feb 27, 2022

sftim Mar 3, 2022

sftim Mar 3, 2022

kbhawkey Feb 27, 2022

sftim Mar 3, 2022

kbhawkey commented Mar 5, 2022

k8s-ci-robot commented Mar 5, 2022

kbhawkey commented Mar 5, 2022

k8s-ci-robot commented Mar 5, 2022

		## {{% heading "whatsnext" %}}

		* Read the `kubectl` [command reference](/docs/reference/kubectl/kubectl/).

Move kubectl overview to be section index #29847

Move kubectl overview to be section index #29847

Conversation

sftim commented Sep 28, 2021 • edited Loading

netlify bot commented Sep 28, 2021 • edited Loading

sftim commented Oct 2, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Oct 26, 2021

jimangel commented Dec 6, 2021

k8s-ci-robot commented Dec 6, 2021

sftim commented Dec 6, 2021

sftim commented Jan 5, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey commented Mar 5, 2022

k8s-ci-robot commented Mar 5, 2022

kbhawkey commented Mar 5, 2022

k8s-ci-robot commented Mar 5, 2022

sftim commented Sep 28, 2021 •

edited

Loading

netlify bot commented Sep 28, 2021 •

edited

Loading