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

Sub-project website for minikube documentation #855

Closed
tstromberg opened this issue May 30, 2019 · 9 comments
Closed

Sub-project website for minikube documentation #855

tstromberg opened this issue May 30, 2019 · 9 comments
Assignees
Labels
area/github-integration Third-party integrations, webhooks, or GitHub Apps

Comments

@tstromberg
Copy link
Contributor

Repository

e.g. kubernetes-sigs/foo

kubernetes/minikube

Project domain

e.g. foo.sigs.k8s.io

minikube.sigs.k8s.io

NOTE: Must match domain request.
See subproject site request docs for more information:
http://git.k8s.io/community/github-management/subproject-site-requests.md#subproject-domain-request

Additional context for request

Any additional information or links to discussions regarding the request.

minikube has a great deal of documentation on GitHub: https://github.com/kubernetes/minikube/tree/master/docs

However, GitHub doesn't do a great job of handling localization of pages. We'd like to use netlify and Hugo be able to use a similar mechanism to the main Kubernetes docs website for hosting localized documentation. Thanks!

@tstromberg tstromberg added the area/github-integration Third-party integrations, webhooks, or GitHub Apps label May 30, 2019
@nikhita
Copy link
Member

nikhita commented May 30, 2019

/assign

@nikhita
Copy link
Member

nikhita commented May 30, 2019

minikube is in the main @kubernetes github org, instead of @kubernetes-sigs. Should the project domain still be minikube.sigs.k8s.io or should it be minikube.k8s.io? Personally, I feel like we should go for the former to ensure consistency but what do y'all think?

cc @cblecker @mrbobbytables

@mrbobbytables
Copy link
Member

I feel like we should go for the former to ensure consistency

I agree. I think it'd be best to avoid adding things to the root of the k8s.io domain directly unless there's a very good reason to do so.

@tstromberg
Copy link
Contributor Author

I prefer shorter names when possible, but I'm entirely amenable to either option. I'm just happy to have a good home for localized project documentation =)

@nikhita
Copy link
Member

nikhita commented Jun 2, 2019

I've almost setup Netlify - the only thing remaining is enabling HTTPS but Netlify tells me that the DNS configuration needs to be setup first.

@tstromberg can you create a netlify.toml file at the root of the minikube repo (example) and create a subproject domain request or create a PR like kubernetes/k8s.io#267?

@tstromberg
Copy link
Contributor Author

@nikhita - Thanks! My apologies for the delay as I've been away on holiday :) I've added a netlify.toml file, and made a subproject domain request: kubernetes/k8s.io#284

@nikhita
Copy link
Member

nikhita commented Jun 19, 2019

This is done 🎉

/close

@k8s-ci-robot
Copy link
Contributor

@nikhita: Closing this issue.

In response to this:

This is done 🎉

/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.

@tstromberg
Copy link
Contributor Author

Thank you @nikhita ! You are awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/github-integration Third-party integrations, webhooks, or GitHub Apps
Projects
None yet
Development

No branches or pull requests

4 participants