Org: netlify integration for kubernetes-sigs/kind

Created on 22 Jan 2019  路  18Comments  路  Source: kubernetes/org

Organization or repository

e.g. kubernetes-sigs/kind

Name of integration

netlify

Link to integration website

https://www.netlify.com/

Describe what is attempting to be accomplished

We're attempting to set up a sub project documentation site, per SIG-docs netlify + hugo is the recommended toolset for this.

Additional context for request

I _think_ the netlify "site" will have access by one member, the maintainers of kind (@munnerz and I) have created https://github.com/kind-ci-robot as a possible option to jointly manage this. If we went this route, the robot would also need to join kubernetes-sigs.

cc @jimangel

aregithub-integration

Most helpful comment

@mengqiy @BenTheElder so, you both had requests pending, even though the above comment shows what the app looked like when I arrived to check this request out

I went ahead and approved them. Please let me know if I broke something that was working.

For the record I based my decision off of the fact that we already have this setup for kubernetes/website, so prior art wins.

All 18 comments

Additionally, we're hoping to find a workable pattern for other SIG subprojects to use :sweat_smile:

I think kubebuilder may already be doing something similar (?) cc @mengqiy

kubebuilder uses netlify + gitbook. And the webhook site is on kubebuilder domain. i.e. book.kubebuilder.io
We use the preview feature and auto-deploy feature from Netlify.
@BenTheElder I'd be happy to chat f2f if you need more details.

that would be great, thanks!

discussed offline with @mengqiy (thanks!) - cc-ing @chenopis
EDIT: And in the SIG-Docs call today, though it sounds like there may be follow-up there.

The contributor site is is a combo of netlify + hugo as well. I know kube-batch would like to someday publish their docs and a combo of [something]+netlify would probably be the best way forward (no more jekyll github pages errors...)

I'm currently working on a project for the CNCF that's basically a Hugo/Netlify/Bulma template: https://github.com/cncf/docs-in-a-box. The goal is to have something that you can git clone and go in just a few minutes, including instructions in the template on getting Netlify set up. The template is still mostly a placeholder but I'll be iterating on it in the coming weeks.

I'm 100% open to feedback on what that template would need to include to be usable out of the box for Kubernetes SIGs.

BTW, you can see what that template currently looks like here: https://docs-in-a-box.netlify.com. Again, still pretty basic but lots of room for growth.

I'd like to see it become a living, breathing project with lots of contributors across CNCF projects. Basically I want to do whatever it takes for this to become a "default" solution for Kubernetes SIGs (and other CNCF projects, and even projects outside the CNCF if they so choose).

re https://github.com/kubernetes/org/issues/397#issuecomment-456935304 This is _really_ cool btw, I forgot to reply here in addition to slack, I would love to see this too :-) :tada:

AFAICT you may already have what you need? Can you confirm?

Third -party access:
screen shot 2019-01-24 at 2 13 04 pm

Installed GitHub Apps:
screen shot 2019-01-24 at 2 12 14 pm

@mengqiy @BenTheElder so, you both had requests pending, even though the above comment shows what the app looked like when I arrived to check this request out

I went ahead and approved them. Please let me know if I broke something that was working.

For the record I based my decision off of the fact that we already have this setup for kubernetes/website, so prior art wins.

eg @mengqiy
screen shot 2019-01-24 at 2 16 53 pm

/assign
since I checked it out
/assign @BenTheElder
can you close this out if you've got what you need?

I think this is all we need from k/org for now, but let me confirm -- I think we may also need to either get a site enabled on the netlify end with some help from sig-docs, or see about getting our bot in the org to enable the site against the bot account somehow..

Thank you!

@spiffxp Everything works fine for kubebuilder on Netlify.
I don't remember why there is a pending request for kubebuilder. Maybe we can get rid of it.

/close

@spiffxp: Closing this issue.

In response to this:

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

Closing the loop a little: Andrew created a Netlify team under Kubernetes for this, thanks everyone!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

hpandeycodeit picture hpandeycodeit  路  3Comments

rlenferink picture rlenferink  路  3Comments

jmyung picture jmyung  路  3Comments

codenrhoden picture codenrhoden  路  3Comments

lpabon picture lpabon  路  3Comments