Skip to content

[WIP] Add kind to learning environments #15056

Closed
opowbow wants to merge 1 commit intokubernetes:masterfrom
opowbow:opkind1A
Closed

[WIP] Add kind to learning environments #15056
opowbow wants to merge 1 commit intokubernetes:masterfrom
opowbow:opkind1A

Conversation

@opowbow
Copy link
Copy Markdown

@opowbow opowbow commented Jun 21, 2019

this refers to git issue #14829
#14829

This is still being worked on

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @opowbow!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 21, 2019
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign tfogo
You can assign the PR to them by writing /assign @tfogo in a comment when ready.

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

Details 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

@opowbow
Copy link
Copy Markdown
Author

opowbow commented Jun 21, 2019

/assign @tfogo

@netlify
Copy link
Copy Markdown

netlify bot commented Jun 21, 2019

Deploy preview for kubernetes-io-master-staging ready!

Built with commit c684a95

https://deploy-preview-15056--kubernetes-io-master-staging.netlify.com

@opowbow
Copy link
Copy Markdown
Author

opowbow commented Jun 23, 2019

/cc @justaugustus @munnerz @BenTheElder
for review also....porting over the kind docs to the learning environments pages in kubernetes/website page.
Let me know if this is the right approach..its still a WIP. thanks!


* multi-node (including HA) clusters
* building Kubernetes release builds from source
* make / bash / docker, bazel, or installing from apt, in addition to pre-published builds
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

oops we need to update this upstream, apt was removed

@BenTheElder
Copy link
Copy Markdown
Member

thanks for the PR and the CC! I'm not sure what the right approach is re porting / linking. 😅

@justaugustus
Copy link
Copy Markdown
Member

I really like this addition!
My concern here would be keeping the data in sync i.e., is it possible to have our site pull in docs from a repo vs making sure the instructions between here and https://github.com/kubernetes-sigs/kind are always in sync?

Do we have a mechanism for that today, @zacharysarah?

@zacharysarah
Copy link
Copy Markdown
Contributor

@opowbow @justaugustus 👋

I really like this addition!

I think the content is great! However, I'm not convinced this PR is the way to add it: see this comment on the original issue.

Do we have a mechanism for that today, @zacharysarah?

We don't, short of a submodule approach, and adding a solution would probably be non-trivial. To recapitulate, I'd rather add this information to KinD and link to it from k/website than dual-source it or submodule it.

@Rajakavitha1
Copy link
Copy Markdown
Contributor

Rajakavitha1 commented Jun 27, 2019

@opowbow @justaugustus

I really like this addition!

I think the content is great! However, I'm not convinced this PR is the way to add it: see this comment on the original issue.

Do we have a mechanism for that today, @zacharysarah?

We don't, short of a submodule approach, and adding a solution would probably be non-trivial. To recapitulate, I'd rather add this information to KinD and link to it from k/website than dual-source it or submodule it.

Hi @zacharysarah !!!! The content in this PR has the same outline as the content in https://kubernetes.io/docs/setup/learning-environment/minikube/. Kubernetes website has a large footprint and users are looking for information to get started with Kubernetes. Right now we only have Minikube as the option to get started with Kubernetes. I agree that it might not be a good idea to recapitulate. However, we could have content to get started with Kubernetes on Kubernetes website and add links for additional information to https://github.com/kubernetes-sigs/kind. In short, we could emulate what https://github.com/kubernetes/minikube has to avoid dual-source or submodule KinD.

@zacharysarah
Copy link
Copy Markdown
Contributor

@Rajakavitha1

Right now we only have Minikube as the option to get started with Kubernetes.

...And Minikube tutorial source lives in k/website. This PR proposes to add content from a source outside the k/website chain, effectively dual-sourcing it, but provides no method to automate freshness or ensure that content receives adequate review.

While I trust that the intentions of everyone involved are 💯 the best, this PR effectively proposes an end run around SIG Docs. That's not a model I want to set up or support, even with the best of intentions.

@opowbow
Copy link
Copy Markdown
Author

opowbow commented Jun 27, 2019

I agree that dual sourcing is not the best approach going forward....is a better way to simply have a KinD page on the learning-environment page ( so users of k/website are informed of this way to set up a cluster) , but the page consists of links back to the actual KinD pages...as @zacharysarah suggested above. The page can be sectioned like the minikube page..and introduced ...but content is wholly linked back to KinD docs? ( again as @zacharysarah suggests ). Thanks for all your helpful comments!

@zacharysarah
Copy link
Copy Markdown
Contributor

@opowbow 👋 Please feel free to /reopen when you're ready to continue with feedback.

/close

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

@zacharysarah: Closed this PR.

Details

In response to this:

@opowbow 👋 Please feel free to /reopen when you're ready to continue with feedback.

/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

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants