Kubernetes SIG Docs, 3 Jan 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: K8S SIG Docs New Contributor Meet and Greet for July 2022

Description

No description was provided for this meeting.
If this is YOUR meeting, an easy way to fix this is to add a description to your video, wherever mtngs.io found it (probably YouTube).

A

Foreign welcome to July's edition of new contributors meet and greet call for seg docs I am Ash, I am the new contributor Ambassador for sick docs, and this call is going to be recorded So and we are going to abide by the cncf code of conduct, which is means be excellent to each other, with that out of the out of the way, let's get started uh the way we do these calls is we first go around like just introducing ourselves and when we do that, uh just please feel free to ask any questions you have about contributing to kubernetes or just can't or any problems you've been facing in general and we'll take them up um after that.

A

If there is some time left, I'll go over some things which I have prepared uh so I guess we can start with Raj.

B

um Hi I'm raspberry University of London I, recently interned at digital product School Munich and currently returned in the family. Yeah I'm getting started with open source.

A

Nice to meet you Raj, uh so once you're done introducing, could you just nominate another person that way the cycle can keep on going.

B

Okay, yeah, maybe.

C

Yep um everyone, my name, is nitesh and I'm. Currently a contributor at kubernetes um got I, guess more than three to four p as much, which is a great thing, so I joined uh one or one month back in the kubernetes community. uh Also talking about the background, I I'm, currently the first year university student, pursuing Mages in computer science and engineering and yeah uh I'm contributing to kubernetes and couple of more cncf projects, um I would like to nominate a rishit for next.

A

It's really nice to hear that you've already got in three four PR's in in your first month. That's a really big deal congrats on that.

C

Thank you so much.

D

uh Hello, I'm Richard uh I've been recently started to contribute to kubernetes, uh also I started attending. A couple of Sig meetings uh got to know about. Si Sig is in Greater detail at kubecon Europe. uh She had been contributing uh a bit before that, but uh I got to know about uh especially Sig docs and some of the nice things they do. So we recently contributing to uh Sig Docs.

A

D

Could you know yeah yeah I was just about to say that yeah uh so uh I'll nominate, Tanya.

E

Hi everyone I am Tanya currently pursuing Bachelors of computer application and I am also contributed to kubernetes and sick talks.

A

Foreign nice looks like we have a good bunch of people who have contributed before and who are totally new. That's always good to have uh samya. Would you like to go next.

F

Yeah, hello, everyone so I am I, am working as a devops engineer. uh I have experience for one year. Only so I have contributed in few projects. uh I don't have much experience in open source, but I have con contributed one time there is one full request that I have submitted uh on the kubernetes website, which has been merged. So that's all from my site.

A

Yeah, that's really cool just getting that first PR in is also a tough job. So that's nice uh Abhishek. Would you like to go next.

A

um Maybe abhishek's internet is problematic Dave. Would you like to go instead, hey Ash, how you are doing I'm doing well? How are you.

G

Oh well: uh I'm, deep I'm, I'm, a student I'm, a front-end developer and uh recently after after the last meeting that we had, uh my two P has got merged in the communities blog website and all thanks to you for sharing those uh first good. First issues so yeah. That's all.

A

It's really cool to hear and yeah.

G

A

Awesome to see that in one month you have gotten two piers in good.

G

Stuff and yeah I've I've been learning about kubernetes uh so as to you know, uh contribute more to the docs as uh there were. There were some of the confusing stuffs and it would be great if you could share some of the bigger resources uh uh you know, uh so it just has to get started.

A

Because I mean get started with kubernetes.

G

Yeah kubernetes and the related things uh because uh from the dogs, sometimes it might be a bit confusing for a beginner like me, because I do not have any idea about devops and the processes behind it. So obviously that uh that's a little bit cubism for me, so yeah I've been searching for some of the resources that could you know help me get started.

A

Okay, uh so uh I don't know if you know, but Dems was like a Community member. He has created this list where he has compiled all useful resources, so I would highly recommend you check this out. It has uh resources related to just learning kubernetes, and then it also has like developer resources, as which like which are about how you can contribute, so give these a try and if you still face trouble, just let me know and I can share some more stuff with you. How does that sound.

G

Thank you, I'm sure I will go through this thanks.

A

Cool uh Abhishek, we are just like going around and introducing ourselves and if you have any questions or if you have been facing problems, contributing just put that out too so, would you like to go now.

A

um I'm not sure if I receive card me, but we can come back to him later, uh I think mija only left. Could you just introduce yourself.

A

Oh all right, uh but just like let everyone know, even if you're an existing contributor, so they can like come to you if they need help about release team stuff and just let everyone know what you do in the team and insect dogs in general, because that I feel is a good starting point for a new contributors. Just joining the release team foreign.

H

I was involved with kubernetes release team earlier uh in 1.23 and 1.24 and yes, I, contribute to docs um and I uh watch PRS and issues, and then I help new contributors to step ahead and make a PR and yes, currently I am a Google summer of code Mandy contributing to cnci project that is, captain and I was also previously LFX. Mandy worked on kubernetes Gateway API project. So yes, that's pretty much about me.

A

Yeah, um so the release team, if for those of you don't know, is the team which is responsible for cutting a new release of kubernetes once every four months and it has various sub teams. uh There is a doc sub team, which I would encourage everyone to apply if you're. Just like looking for a more guided path in the sub team, you will have a team lead and they would like they would have three four shadows and they get mentored through the cycle. So it's a pretty good starting point.

A

If you are a new contributor, so just check that out too well, I I think we are done with all introductions and we have 15 minutes left about. So what I wanted to do in this call is just uh show everyone how you can run the kubernetes website locally, because I had been getting some DMS and uh about people facing trouble with that.

A

uh Can you all see my screen before we proceed? I just want to confirm that.

A

Yes, okay, all right! uh So if you go to uh kubernetes forward slash website, this is where the code for kubernetes.io lives and when you want to contribute, it is important that you are able to like run the website locally, because you will need to be able to see the changes you make before submitting a pull request, and uh this is something uh people have been facing trouble with.

A

So I thought we'll cover that first thing you just need to do is clone the code and you can do that by running git clone and this website uh uses Hugo and it uses a Hugo theme called doxy. So I think where people Hugo is just basically um site generator and doxy is the theme which is like which you see like this is all a theme.

A

This is all pre-configured in the theme so where people face problem is that this code does not contain doxy, because doxy is like another project, so you have to clone that uh separately, which I'll show once we are done, cloning this, which itself is a pretty big site like for a great repo, but let's go when it is for you.

A

While we wait for this, like do, uh is this someone who has already done this and is familiar with it or have you folks not tried? This I would just want to know.

A

I guess Maya is the only one who has done it before. Okay, so I hope this will be useful. uh So once you are done with that uh remember this is the command. You need to run to clone the doxy theme. Also- and this is the step most people like forget- and oh wait. First, we need to go into the folder and then this will just fetch in the theme which is needed, because if the theme is not present locally, then you will not be able to bring up the site.

A

uh Any questions so far about like what I'm doing right these are just like uh standard kit commands like git clone. uh You don't need to be super familiar and super Advanced with Git.

A

Okay, so once we have that clone to the I've just like opened the repository in my code, editor and open the terminal here and then, if you just want to run it locally, the first thing you'll need to do is like do a clean, install of the project in general.

A

And this should be super quick and after that, all you need to do is run, makes a and what makes service so there's a make file at the root of the repository, and it contains like all these commands. You can run so you can run, make all make build mail, make build preview and service, another command which runs this command, basically, which is the command for Hugo, to run your actual like build the website and run it.

A

So if you now see it says that the website is live at localhost 1330, and here you can see it now, you can just make changes. So if we just search for this, let's see uh yeah and if we see this hyperlink and if you want to change it to, let's say: okay and you can hit save and it changed right. So uh this is basically how you run the website locally, and now you can like just make changes and test them out and do what not uh before making your final PRS.

B

A

B

Yep yeah, so, while reading the dogs I have prepared somebody, you know like the dogs are like a lot of files, so so I have prepared a summary which includes getting started for shadow release. Chronological.

A

uh Raj your voice got disconnected.

B

But could you could you repeat what I was saying, I have typed into the chat? Can you.

A

Okay, wait. Let me.

A

uh So where is this summary living exactly.

B

Right now it's it's. My notebook I can convert into a dog.

A

So uh where do you like want to make the PR2, and where do you want to add this.

B

Like in the same repos that have sick release,.

A

Okay, uh so Sig release already has like role handbooks for different, like roles, so maybe uh you can like, instead of creating a new page, just make edits to that. One and suggest changes like I can give you the links to the old handbooks after the call.

B

uh I have read those yeah.

A

Yeah, uh so uh is it is either Pages you're suggesting along the same lines or like? Are they different.

B

Like it would contain uh a summary and a chronological order, through which a new member can go through to get familiarized with all of the stuff as like right now, I spent considerable long amount of time buying, while going through all of the talks.

A

Okay, um I would suggest like before making the actual PR you once like. Have this discussion in the Sig release Channel and see what other people have to say about it and then like? If there is a common consensus, then just like go for it.

B

A

Cool, um so this is mainly what I wanted to show about like how you can clone the website and run it locally and see all the changes you make reflected live. Does anybody have any questions related to that.

A

A

I guess not uh so we still have like if nobody has any questions like we can give back everyone 10 minutes of their time and and they call now but I'll stay on for a minute, just in case anyone wants to discuss anything. Thank you. So much for attending and I hope to see you all in the next one and I hope this was useful for everyone.

I

A

Thanks for attending um I guess this: is it I'll now stop the recording and in the call bye. Everyone have a great day.

A