Kubernetes SIG Docs, 23 Aug 2023

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: [SIG Docs] Monthly APAC Community Meeting for 20230823

Description

[SIG Docs] Monthly APAC Community Meeting for 20230823

A

uh So hello, everyone, this is um the sick dogs, APAC friendly meeting for the month of August, um I'm, Divya and I'm. The coaching for sick dogs and joining me is Tim uh today, who's fairly early for this time zone, but hi Tim and, um as we always say on these calls, um uh the calls are governed by the kubernetes code of conduct, uh which boils down to please be nice to one another um and uh please refrain from the use of any harsh or abusive language on the call and otherwise as well.

A

So it's um it's not like just the squad, um but okay, um the agenda for this call uh I will drop the link here um and uh it's already preset, uh there's not a lot of discussion items to be honest. um So if anybody on the call has any uh outstanding discussion items, please feel free to add them here. I shall be sharing the screen in a bit so that uh y'all can see it all right. Okay, so hopefully everyone can see my screen and I am not yeah.

A

So uh I, don't think any of us are new contributors here, but if they do end up coming, please have them enter the names yeah.

A

uh So I'll go with some of the housekeeping updates, which are uh um you know the uh PR Wranglers for this, the subsequent and the Very uh first week of September, uh so the uh this week's PR Wrangler is neat and um they W uh on slack as well as on GitHub, and uh next weeks is um Anna and the first week of September has read um now you uh can check out the pr Wrangler shifts um for uh the until the end of this year uh by going to that link on the agenda, and um should you want to actually, you know, have some experience um in how we all do this, um how the approvers actually go about approving and reviewing PRS.

A

Please ensure uh you sign up for the pr Wrangler Shadow program, um via which you can actually work alongside uh the pr Wrangler for the week and uh get some experience in that regard. um Just pause for any questions. uh I know there might be none, but I'm. Just gonna pause for questions. If um anybody has uh anything regarding what I've just said.

A

I'm gonna take that silence as a no. So if at any point uh you have questions, please stop me.

A

um Next up, uh we have um the agenda items.

A

um uh The first one is that um the release 1.29 is going to be underway, starting September 5th, if I'm not getting my dates wrong and uh the shadow applications for the 1.29 release team are open. So there's a link here in the agenda documentation and um you all can follow that link and fill out the form, and uh it's pretty much. You know an application for being a shadow on the release team.

A

You just have to give out the necessary details um uh relevant to sick, docs, I, think um the release team leads are who's. You know overseeing the entire release. 1.29 um uh Xander, who is uh the Emeritus advisor uh cat and Carol, will be the dogs and comms vertical leads respectively and will be um also um you know representing um on these calls or have their Shadows represent on these calls.

A

We have actually requested that uh this be the case, um so we are going to attend like Tim, my I, don't know if Tim is available, but myself, Ray and Natalie are at least planning to attend a retro or this evening um late evening for us, but um early morning, free and request for uh this to actually be mandated, because um you know it would help if the uh comms or dogs T vertical from the release team actually showed up on these calls and gave the updates themselves um and flagged any issues rather than us actually um going ahead, and you know uh because uh you know pinging them separately for it.

A

They just have to enter their updates or under this section of the agenda um we are. uh These were some of the action items from yesterday, so um we are uh like I said we're gonna attend the call, but uh we also are going to suggest this is a mandate and uh Natalie who is one of the co-chairs uh from sick dogs has kindly agreed to take on the um you know: responsibility of uh informing the uh leads of the next cycle of this change and also to help them document it in their role book.

A

I. Think it's already documented for what it's worth so uh I. Don't think we need to do it again, but um I think mandating. It is the thing that uh we are probably gonna ask for and have it documented like explicit, so I'll I'll pause for a bit there. Does anybody have any questions about what I just said, because that was a lot of info dump from my side.

B

A

All right so I'm gonna take Tim's no and the Silence from the rest of the art audience has no hand going ahead with the rest of the agenda. uh We come into the issues in PRS, uh Tim I see that you've entered something Josh. uh Do you want to speak to it? Please um I know you probably have actually done this last uh meeting, but yeah.

C

Well, no I, I um I didn't realize we were having two meetings: that's okay, um yeah. So this is the chance for people in in this call to to learn that I I proposed a change to how we do feature Gates um to have maybe have a quick look at the the backing issue and the pull request, especially I'm, not really looking for code review in terms of like the implementation I'm. Looking for intention review like do, we want to do the change that I've proposed overall.

C

A

C

Have to say that that issue is probably less of a good example than having a look at the pull request.

B

A

C

um Essentially, the the appearance of the page hardly changes, but the way it's done changes we end up with a a large number of small files. One file per feature gate.

A

Right, okay, so let me bring this up to you. I.

C

I would switch to the I would switch to the uh the files view of the pr and.

A

C

You'll see an example file for a Fiji gate as how it's done the issue. The issue is like from a couple of years ago: I think.

A

Oh, my goodness yeah okay, this is this is what I have and there's a lot of stuff here. So do you have any particular file? You want me to uh point to like an accelerator, for example, do you want me.

C

To go there, yes, this view I hope gives people a sense of what you've got so just taking that accelerators. That thing um this is the data like I say there is some code that you can see that the templating, from which you know a reviewer, will look at what you might want to comment on more. What I'm interested on feedback from from from everyone is.

C

Do we like the idea of splitting this out? Do we like the idea that each feature gate gets its own file? What are the disadvantages? People might think of. What are the advantages? I can also explain if people have questions. Why did you do this? Tim I can answer that.

A

um I I have just one thing in mind, probably um from uh maintenance perspective like once. This is in from a maintenance perspective, it I think it'll be definitely easier, but uh because again it is just gonna require a single file to be updated. uh Given you know a particular feature, kit, I, guess and I'm not sure, but I feel like.

A

That would be one of the advantages, but uh I think also there's like a lot of files to be merged in one single PR uh and it's a huge, huge, PR I know: we've seen bigger PRS than this I'm, not saying no, but uh I think this is a huge PR to uh tackle on like in. Like a single instance. That's that's again my opinion, uh but you might want to explain the rational behind this.

C

Yeah I guess in terms of the size I want to do all of the feature Gates. It wouldn't really make sense to me if.

A

You do it one by one: I get it yeah.

C

No yeah I don't want to do 250 P hours either. Yeah amazing, as that might make my contributor statistics look like you know. It's.

B

Which are already Amazing by the way Tim, uh which are.

A

Really amazing, by the way I've I've been looking at some of the contributor stats to be presenting at like um kubecon and uh I I would.

B

I would probably give you multiple, shout outs if that were the case, but.

A

uh That's that's an aside uh uh and I completely get why you know you will not make 250 PR but I'm. Just saying that, like there's like a huge PR in itself, but yes, please go ahead so.

C

It's it's a big PR by its necessity, but this is a smaller I. I opened a bigger change, so the um the thing the thing I originally proposed, I think maybe in 2020 um hey, you know: I've got a computer. Let me look when I proposed. The original, bigger change um did more than this piano.

B

C

Was it was December 2020.

B

C

What I proposed originally was not just this, but in the front matter where you've got the title. The content type and some underscore build metadata. I also had information about what versions of kubernetes this had been at different stages, so Alpha Beta, stable, deprecated.

A

C

This PR does not do that and in that sense I am making it smaller. I know it's extra extra large but I'm, making it a smaller change than I originally proposed.

A

I think it's valuable I'm not gonna. Take that away from it um definitely valuable in my opinion and um I will I'll definitely check it out, um but anybody else on the call uh has any thoughts, but at least feel free to ask questions um or you know, share your thoughts actually about whatever Germans just said.

A

I'm not sure Michelle, if you're speaking, because you are unmuted but I can't show you, so you might want to check your mic if you speak.

C

The question in the zoom chat I'm happy to answer it.

A

Yeah that also works by the way.

A

I'm, just gonna take a note here in the meanwhile that um you are looking out for.

A

C

In the other called Nate, uh who is the pr Wrangler, uh has you know volunteered I volunteer to take a look uh Bishop in terms of contributing um I think the kinds of contributions that are good now are you could do a nitpicking review? So let's say that I've copied over some text, but you've noticed that one of the words is spelled wrong in my version, and you know it was right in the original. So if you compare all of the words and go if you you'll want to do that, that's a way to help.

C

Now, if that's a lot of work, what you might want to do is split the work and and say I'd like to do just the A's and then I have checked all of the feature games, beginning with a word for word and I stopped at the end of a.

C

All right does that make sense bishall as a as a uh as a thing to do cool. Just if you know- and you can you can do that on your own initiative, you don't need to agree with other people. You can say I started at guineaway went through a that was enough for me. That was plenty of of effort. I stopped! You don't need to get permission from anyone to do that.

C

um And for anyone who's interested um another thing that you can do is um think about how you might follow this up. So you could ask questions about well, hey um I've, seen this issue and I can see. We've got a pull request which just the first bit I think the next bit looks like this.

C

Have I got that right, so you know you, you might have one opinion about what we should do next and you can already start thinking about the next steps and that discussion and the issue would be very useful actually because uh oh um and Siobhan's got a I. Think an unrelated question to to this I was just saying about. This is a very complicated pull request.

C

um This might be the most complicated pull request, we'll review for a few months, uh but we'll come to your question in a second I. Don't have anything more to say on on reviews and next steps.

A

Okay, so um summarizing what you've just said, uh we're looking out for intentional reviews from contributors and potential areas to actually contribute on the request. I've written those on the document as well, uh potential areas to contribute uh would be nitpicking, reviews uh or you know, reviewing specific chunks of files, maybe starting with a specific alphabet or related to a particular area. However, you'd feel comfortable uh and also think about how you can follow this up with, like the next steps. Does that sound okay, based on what we just discussed.

C

Sure, and if anyone wants to do a full review of this massive PR, you are welcome to as well. Just you know set set yourself down with a warm drink. You know uh before because.

B

For several days for several days, that would that would be more realistic at this point.

C

Should we go to shivam's question.

A

Yes, that would be great, please.

A

um You probably have to read out because I can't see the chat uh if.

C

You can see that please stop I'm asked I am here to learn how to contribute in sick docs. Is this right place.

A

um Absolutely since this is the sick dog score, so you're in the right place, uh you know I'm just gonna write it here. You have to contribute to sick talks.

A

um So I would first um I, don't know if you've already joined our channel. So one of the things that you can do is join the slack Channel um uh I do not know um uh whether or not you have so slack.kates dot. Io. Okay, uh slack.kates.io is the slack Channel. We hang out in um most of the time. So we have a bunch of resources print to that channel and uh we think they would be helpful to um you know anyone who's beginning to contribute or anyone.

A

You know who's looking to restart contributing um either way. It is pretty useful as far as um as far as we go um and uh there's also a new contributor Ambassador call that we have um every uh start of the month uh that will be in two weeks uh on Tuesday. We have this uh call where the new contributor Ambassador arsh gathers uh with uh all the new contributors.

A

um If you sign up to our mailing list, you'll get the invite for that call as well and um to gain a better understanding of how and where you can contribute. If you're like starting out fresh or um stuff like that, but the recommendation is to join the mailing list. Join the slack Channel and um you know, uh join the new contributor call because it really helps uh to have like a person guide you uh rather than us just like breezing through whatever we know uh so yeah I I, don't know!

A

If that answers your question or I, don't know if Tim actually wants to add on to something there.

A

um Not sure if it answered your question, um sorry, oh.

C

I might add it one thing: um you know I'm Shivan. What language you know would you interested in contributing? Is that English or is that another language.

B

A

ah Okay, so if it's English I think um this is the best please, she can beard um in case you're interested in uh one of the other Indian languages like Tamil or Hindi. We have localizations with artist bars, so those are potential areas you can contribute to as well, uh but um I think with respect to next steps. uh What I would recommend, as uh you know, something that you would you know that would help you is a join. The mailing list join the slack Channel and check out the stuff.

A

That's been to the slack Channel like we have the links to the contributed, documentation, Etc and uh attend a new contributor call um every um that's that's held every month, uh first Tuesday of every month, which would be I, think the fourth, uh no the fifth of uh September, if I'm not mistaken, um so yeah, those are the next steps that I can think of.

A

um But did we answer your question uh Shivam or do you have any further doubts.

A

I am gonna, take the silences. So if there are any questions, please feel free to leave them in the chat, uh but yeah we're going to um the next uh questions or discussion points section or wherein.

A

uh First up was your question Shivam and the second one was around ideas for our dog Sprint at kubecon, any uh contributor Summit. So um I don't know if everyone on the call knows but I'm just gonna reiterate for those who don't so every kubecon we have a contributor Summit um and uh typically we have docs prints at both.

A

These uh add both these coupons that have at most coupons uh the kubecon China One I, don't think we have any but uh um uh keep on any, and you are places where a lot of our uh contributors gather and we have docs printed both of these um uh contributor Summits and uh we're looking for ideas for this year's contributor, Summit, uh dog, Sprint and um I think we're doing one um so Abby is uh um Abby.

A

Mccarthy is one of our localization leads and uh she was one of the driving forces behind the talk Sprint at uh a previous kubecon, so uh she's, going to uh post it uh post uh on slack regarding the facilitation of the dog Sprint and to make sure that folks who are at cubeconne are able to attend it.

A

So so, essentially, if there are ideas that you have and you plan on attending cubecon any uh contributor Summit, uh please chime in with your opponents on that uh post uh whenever it does get posted Abby will be posting it in a couple of days, I'm sure so um yeah, that's that's regarding the docs Sprint, or does anybody have any questions around it.

A

Okay, so I'm, just uh um okay, now I think um bishal has asked a question: what is a PR Wrangler Shadow? uh Would you mind to tell something about it? So uh a PR angular Shadow I'm just going to open the um page um so that you know what I'm exactly talking about uh instead of me, just blabbering stuff. So so, if you can see um this schedule here, um uh these are the pr Wranglers. Now what are they?

A

um uh You must have seen the number of pull requests on uh K website, and you must know that you know uh these PRS go through a specific set of reviews and approvals uh both from a technical as well as from a qualitative perspective.

A

um Since you lead the, uh since you are one of the uh reviewers for Hindi, localization I assume that's something you know, but um with respect to the English website, uh what happens is since we have a larger volume of PRS in coming every day, around 25 to 30 PR's incoming per day, um we take turns on a weekly basis uh by V I mean sick, docs approvals, take turns um on uh reviewing and approving PRS that are incoming 2K website um on a regular basis, and uh we actually uh you know, we actually ensure that all the um coordination and Technical povs and everything is done so uh basically approving and reviewing for uh English website PR.

A

This is what is a PR Wrangler this we do this on a weekly basis, and the schedule is here. um The link to that schedule is also there on the agenda documentation. Now, when you Shadow a PR Wrangler what you essentially learn how what to do is how to do all of this for the English website, PR's, uh that is, for the main website, as we call it um primarily because we have a larger volume, we have to actually um lash with a bigger um stakeholder set as compared to you know.

A

Smaller stakeholder sets in uh the localization, um and uh you understand the you know, mechanics behind the actual approval and review process, so uh you will actually be working alongside the approver for that one week. uh Whoever you choose uh for that one week and uh you will learn alongside them, how to approve and review PRS.

A

So um that is the pr Wrangler Shadow, it's not a program, but it's you can call it a program because it's ongoing and it's not like a project where it just stops so yeah. That is the pr Wrangler Shadow thing all together.

A

um Does that answer your question Bishop.

A

All right um so uh I think uh there was another question um Shivam. You said that I cleared your dot, but your doubt is something else. uh Would you care to elaborate uh what the doubt was so that I can actually address it because I don't know what you were trying to say and I based I mean I assumed what you were trying to say and I answered that question. So if there is a doubt, if there's something that I'm not clarified, please make sure you attend.

A

uh I mean you write it on the chat and we can get to answering it uh so yeah so other than that. um While we wait for Shivam to come back with his question, uh one of the other things that we are actively working I mean not working discussing on uh would be the generative AI discussion.

A

uh So um there is um an ongoing discussion on uh whether uh we want to use generative AI for kubernetes talks, and um this discussion was started um on July 11th at one of the EU U.S meetings by Robert Reeves from the Linux foundation.

A

So these were the notes and I would encourage you to go through the notes and uh understand the context behind this discussion and chime in with their opinions. If this is something um you feel strongly about, um in terms of you know a center design, that's not a problem, but uh essentially, if this is something uh that you know, you feel that should be incorporated on our dog, so should not be incorporated in our dogs based on wherever you stand, um please feel free to chime in uh the link.

A

Is there on the agenda documentation again, so um we would need to give robot ideas. He I think he was there on the call yesterday, but uh we would need ideas that are visible to take back to LF, uh which is the mothership and uh uh we're also uh in requirement of a proof of concept right, because we cannot just randomly say: okay, we want to work on this and then uh stop and then not do any work in it. So we need a proof of concept or something to show the starting committee.

A

What is the actual value behind this uh thing? So any any suggestions that you have any inputs that you have regarding this matter would be highly appreciated, and the discussion link is linked here in the agenda. Documentation would request that you go and chime in with your opinions, um I'll pause here to take any questions around this or Tim. If you have any other inputs around, this I will pause here to take that.

C

um Well, uh on on the generative AI thing, I've put my comments on the discussion. So no I I won't repeat those things there you can. If you want to see my thoughts, I've.

A

Got okay so the, um but are you just came back with a question around how do I become a PR Wrangler Shadow? uh So if you want to become a PR Wrangler Shadow, you just need to State your intent by dming, uh one of the tech leads or one of the coaches regarding your intent for future dates. Of course, um so you just need to State your intent um and we'll be able to edit that and incorporate you as a shadow. uh It does that make sense.

A

um That's not yeah! Please tell me: oh yeah,.

C

B

Things, yes, please.

C

The approach I recommend is that if you find a a Wrangler, you know maybe not next week but a few weeks away uh who's someone who's in the rotor. This is the approach I've recorded in the past. So you know, let's say you want to Shadow from three weeks from now. You look in the rotor. No one is down as having a shadow listed I'd approach that Wrangler, not not a chair or a tech, lead and say Hey. You know you're an approver you're going to be the pr Wrangler.

C

Could I Shadow you and and approach that way.

A

Also a good way but I don't know if they'll have uh approval I mean if they'll have edit rights on the pr Wrangler Rota. That's the thing.

C

So uh you're right Divya, um if you're an approver watching this video and you need to make an edit. That's where you can ask in sick docs, maintainers or message yeah, exactly messages.

B

C

But I don't mind if the approver gets the uh you know. Does the edit, on behalf of the person who's gonna, be a shadow absolutely.

A

That works as well like I, don't have a problem either way. It's just how you choose to approve approach. It um I'm fine, either way um but yeah. That's that's! Essentially how you become a PR, Wrangler Shadow, there's no complicated form filling you just have to approach.

A

Hopefully that answer your question. Michelle.

A

Okay, so um has mentioned that he has launched many Tools in kubernetes but uh is getting overwhelmed when he visits the GitHub repository of kubernetes. So is there any thing step by step process to conquer the next step? So essentially that's what I mentioned a while back uh first up um I know that you've visited the GitHub repository and are getting overwhelmed is exactly why I gave you the step by step. First, you joined the mailing list. First, you join the slack Channel, um which is slack.kh dot.

A

Io um in this, you will have links to uh many of the six that are working on different things um on the various repos that you see in GitHub um use asked specifically to sick dogs, so I'm, giving you specific to sick, docs information so specific to sick docs. We have a channel um hash, sick, docs, and here you will find um um uh you'll find um in information relevant to the contribution to sick docs um uh paint to the top of the channel. You can go and check out.

A

um Similarly, if you are interested in other stuff um not relevant to docs, not specific to docs, you can visit those channels as well and ask them um part uh specific to sick dogs. This uh joining the slack Channel and you will uh you'll also be intimated, um I think you'll. All we also have the mailing list on uh put into the top of the channel, uh so you can also join the mailing list directly from there and by joining the mailing list.

A

You'll get access to the calendar, invites we've also linked the PRS uh that require urgent issues that require urgent attention so and our contribution guide, which lists step by step uh from a technical perspective. What needs to be done if you're contributing to sick dogs, so we have all of that there. So that's that's. Why that's the very first step that I recommended was to actually you know, join the slack chat and um check out the resources there.

C

In the in the chat, I've also mentioned that we have a uh a new contributor um meet and greet um which I've now added to our slack Channel as a pinned message, because it's not something that was pinned until oh.

A

C

A minute or two ago, um so you can join that call um which is I've not been a new contributor for a while. So I don't actually know when it happened.

C

It is um 10 30 UTC on a Tuesday which.

A

Is 4 P.M uh ISD um for those located in India, so that would like be a better translation, so 4pm IST um on the first uh Tuesday of every month our Sharma actually hosts the call, and sometimes, if we have bandwidthy pop by, but um mostly it's just a new contributor Ambassador with a bunch of other new contributors.

A

um uh You know having similar questions, is you or or maybe, different questions than you uh on the call hanging out in the call and having uh uh you know their questions and queries resolved?

A

Does that make sense.

A

All right, um I think that's pretty much the end of the um okay I think that's pretty much the end of the agenda that we had uh so I ordered before you know. I say that we're parting, the call or does anybody have any questions or uh queries or suggestions or anything uh that need to be added to the agenda and discussed um I? Will you know, wait for a bit uh I, don't want to say five or ten or something like that.

A

Okay, I'll wait for a bit before you know, I, ask again uh and then part the call, but if you have any questions, you're also there on slack. So please don't worry uh that you know this is the only place where we hang out. We hang out on slack as well, uh so please feel free to actually ask your issues publicly on slack as well. We do not buy type ROMs.

A

All right, then, I think that's it uh from our side and um hope you all gained a little more insight into the workings of sick dogs. Then you all you before so I'm gonna point this call and give you 15 minutes of your time back. I, guess uh so, 15 minutes of your time back so that y'all can go and take a breather before your next call or not so yeah have a great day. Everyone and I'll see you around. In slack there bye.

C