Org: Sub-project website for minikube documentation

Created on 30 May 2019  路  9Comments  路  Source: kubernetes/org

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!

aregithub-integration

Most helpful comment

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.

All 9 comments

/assign

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

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.

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 =)

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 https://github.com/kubernetes/k8s.io/pull/267?

@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: https://github.com/kubernetes/k8s.io/issues/284

This is done :tada:

/close

@nikhita: Closing this issue.

In response to this:

This is done :tada:

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

Thank you @nikhita ! You are awesome!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

hpandeycodeit picture hpandeycodeit  路  3Comments

ahmad-diaa picture ahmad-diaa  路  3Comments

aravindputrevu picture aravindputrevu  路  3Comments

ashish-amarnath picture ashish-amarnath  路  3Comments

jmyung picture jmyung  路  3Comments