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.

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

Kubeadm included snippets are published and indexed. #8982

Closed
1 of 2 tasks
steveperry-53 opened this issue Jun 7, 2018 · 9 comments
Closed
1 of 2 tasks

Kubeadm included snippets are published and indexed. #8982

steveperry-53 opened this issue Jun 7, 2018 · 9 comments
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@steveperry-53
Copy link
Contributor

This is a...

  • Feature Request
  • Bug Report

Problem:
This problem applies to several kubeadm topics, but I'll illustrate with one example.

The kubeadm init topic has some authored content along with an included snippet that is generated. The generated snippet is here.

The problem is that the snippet is getting published as a standalone topic:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/

Also, the standalone snippet topic is indexed and can be found through search.
Search for this:
kubeadm site:kubernetes.io inurl:kubeadm/generated

This problem was not created by the Hugo migration. The 1.9 docs have the same problem.
https://v1-9.docs.kubernetes.io/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/

Proposed Solution:
If possible, find a way for the snippets to not be published.
If that is not possible, remove the snippets from the search index.

Page to Update:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-init/
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/
...
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-version/

@steveperry-53 steveperry-53 added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jun 7, 2018
@steveperry-53
Copy link
Contributor Author

/cc @fabriziopandini
/cc @Bradamant3
/cc @chenopis

@neolit123
Copy link
Member

@steveperry-53
as discussed yesterday with @Bradamant3 , we are leaning towards removing all authored content from the reference pages like the one for kubeadm init and moving that to existing pages for creating a cluster with kubeadm.

ref: kubernetes/kubeadm#899

@neolit123
Copy link
Member

@kubernetes/sig-cluster-lifecycle-misc

@k8s-ci-robot k8s-ci-robot added the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Jun 7, 2018
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2018
@neolit123
Copy link
Member

neolit123 commented Sep 5, 2018

The problem is that the snippet is getting published as a standalone topic:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/generated/kubeadm_init/

still not sure why this is happening.

/remove-lifecycle stale
/kind bug
/assign

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Sep 5, 2018
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 16, 2018
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 15, 2019
@fejta-bot
Copy link

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@k8s-ci-robot
Copy link
Contributor

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

No branches or pull requests

5 participants