kubernetes-sigs / sig-multicluster-site

Outreach and central subproject docs site for SIG-Multicluster
Apache License 2.0
14 stars 7 forks source link

Set up deployment pipeline for this repo's site #4

Closed lauralorenz closed 1 year ago

lauralorenz commented 1 year ago

Per the README, and in the proposal site, we would deploy from local using the directions on the mkdocs website. The Gateway API website appears to use netlify instead (https://github.com/kubernetes-sigs/gateway-api/pull/559) and this also appears to be how they got proper DNS resolution from *.k8s.io so I would like us to do that. Determine if we want to do the same; otherwise set up GitHub Actions to deploy automatically on a merge into the main branch.

lauralorenz commented 1 year ago

Follow up on how to do this for reals, ty @mrbobbytables

  1. Create a netlify.toml (can borrow from other sites like k8s contributor site source or gateway api source) and modify as needed
  2. Open a netlify request issue (there is a template in k/org) to hook this repo up to deployment via netlify
  3. Request DNS to be set up via an issue to k/k8s.io for the netlify site to be directed to from mutlicluster.sigs.k8s.io

cc @npintaux

jmhbnz commented 1 year ago

Hey @lauralorenz - I'm keen to support sig-multicluster. I have raised a pr with some ideas on initial scaffolding for building the site via netlify 🙏🏻

lauralorenz commented 1 year ago

Awesome thank you @jmhbnz !!!!

jmhbnz commented 1 year ago

Hey @lauralorenz with the initial scaffolding for netlify.toml merged do we have an issue open for step two?

I'm happy to raise if not, looking at the template it looks like we just need to supply two values, here is what I would propose:

Repository

Project domain

npintaux commented 1 year ago

Hi @jmhbnz , I have just raised the issue per your recommendation. As I am learning the intricacies of k8s OSS projects on GitHub, is there anything I need to do? I saw in other issues that some people were assigning mrbobbytables to them.

lauralorenz commented 1 year ago

@mrbobbytables took a very quick look and said a better template for our netlify.toml would be this one in kueue. Basically we don't need the redirects in the netlify.toml (the ones in the Gateway example are out of date as netlify actually switched from netlify.com to netlify.app, and whatever netlify might have needed in the past to detect the proper prod branch is apparently no longer needed) so we can take those out.

For the actual netlify issue now that it's raised we need a github admin to help us, I'm poking around on slack some too to see if we can get in someone's TODO list any time soon :) Thank you @jmhbnz and @npintaux !!

jmhbnz commented 1 year ago

Thanks for the feedback @lauralorenz - I've raised #7 to tidy up those unnecessary redirects and also streamline the local environment setup for the site.

Fingers crossed we can get the netlify domain setup soon! 🙏🏻

lauralorenz commented 1 year ago

Ok netlify is setup (see https://github.com/kubernetes/org/issues/4086), if someone can run point for the DNS request that would be great!

jmhbnz commented 1 year ago

Great news! Ok I have raised our dns request here to get the CNAME for the new netlify address: https://github.com/kubernetes/k8s.io/issues/4991

Edit: Have raised the dns pull request to try and speed things up: https://github.com/kubernetes/k8s.io/pull/5068

Edit2: Dns request completed, now just need a quick update on netlify side and will be all done :)

jmhbnz commented 1 year ago

Hey @lauralorenz - Site pipeline is done along with dns, all running nicely here: https://multicluster.sigs.k8s.io

I think we can close this now? 🙏🏻

lauralorenz commented 1 year ago

Yes all looks good and we successfully had a merge and redeploy all work too! YAY! Thank you everyone!!!

/close

k8s-ci-robot commented 1 year ago

@lauralorenz: Closing this issue.

In response to [this](https://github.com/kubernetes-sigs/sig-multicluster-site/issues/4#issuecomment-1524051307): >Yes all looks good and we successfully had a merge and redeploy all work too! YAY! Thank you everyone!!! > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.