Kubernetes SIG Docs, 8 Aug 2023

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: [SIG Docs] Bi-Weekly Community Meeting for 20230808

Description

[SIG Docs] Bi-Weekly Community Meeting for 20230808

A

Hey folks, hey folks, welcome to the August 8 2023 kubernetes meeting uh I'm your host today. My name is Ray lahana I'm, one of the co-chairs for kubernetes sick docs. uh We do abide by the cncf code of conduct, so be mindful of what you say and also be kind and be and be excellent to each other, and this mini is also recorded and uploaded to YouTube after the uh this meeting.

A

So uh please be mindful what do you say that will be uh persistent on YouTube I'm going to share my screen here I've also, let me make sure about link to the agenda in the in the chats.

A

All right, uh so this is our meeting agenda for and we'd like to welcome any new contributors, so we'll give I'll give a few minutes for anyone. That's new that would like to introduce themselves.

B

Yeah myself, a fun and I'm a computer science, student and I am fairly new to that kubernetes community and I'm willing to contribute in sick Docs.

A

Welcome welcome.

C

Hey folks, my name is Brad I'm. The um comes lead for the 1.28 release, so I just came to the line and and solve a couple problems together.

A

Thank you. Thank you very much for joining.

C

D

D

All right, great.

A

To see everyone again great to see some uh familiar faces, uh welcome back to some of you folks, as well so I'll continue. um I should be sharing my screen here. uh This week's PR WR Wrangler is Natalie. So if you have any open PRS, your PR Wrangler for this week is daily uh next week is Divya and the following is Nate um I and uh several other sick docs reviewers will also continually review I I I do some here and there so watch out for some PRS as well.

A

For this week, um there's a link to your PR Wrangler shifts as well on the agenda. So, if you'd like to take a look, um also, if you notice any as code of conduct, violations as well and meetings get up comments or slack, uh there's a link on the agenda for the kubernetes code of conduct committee as well, so you can reach out anonymously uh if you need to I, do want to start off since this next week is the scheduled release for release 128..

A

uh Is there anyone from the 128 release team from the docs or comms team that would like to give us updates? Please.

C

Yeah so it doesn't look like we have, uh you know from docs, but we have Leo.

C

Oh sorry, sorry yeah.

D

Yeah, it's cool, Dark, Shadow, hello, my name is cat. Cosgrove um today is indeed the docs deadline.

D

um We have just gone through and updated the project board to double check everything we have uh nine PR's outstanding, still um undergoing review, so I will run through after this meeting and bother everybody and remind them that today is the deadline, but everything else is merged, so I'm I'm going to call us uh I, don't know.

D

I um nine makes me nervous, even though I know this happens every time, so I'm probably going to call that red um race can feel free to uh dial me back on that one, but it uh it feels a little bit read to me. uh Leo do I need help. um I am okay.

D

Well, I'm gonna write one message and copy and paste it into all of the PRS, but uh if there are VR owners that you.

E

D

In the board that you know personally and can get a hold of in a separate way, feel free to remind them. That uh today is the deadline.

B

D

We will take.

F

Shadow are ready to go if you.

C

Need help reaching out okay.

D

Thank you, I appreciate it.

A

D

A

Something else all right: that's a much better number than what I looked at. um Just from my query and the agenda just to look at open, PR is going to be damn 128 Branch, that's uh so I have 16, but four are in draft. I have a sense that those folks that the prsm draft might be for enhancements are no longer tracked.

A

um So if the dock scene can uh can take uh some time to just just review the open PRS they're, targeting the devil, 28 Branch received. uh Sometimes I saw two two today so close those two um that uh if there's any if they're Associated uh an enhancements not no longer targeting 128 to just to close them into make a comment uh about clothing.

D

I'll tell Rishi to go. Take a look at that.

G

Thank you. You know if, if, depending on how the closure looks, um you know it might be worth saying to the author. Look, this will be great documentation. You know, please keep your work around and and retarget it to dev129 when you're ready, because you know we like to be nice to people, we try to be activated one another.

A

Yeah I also like to see if this is incorrect, he could reopen with that slash reopen in the car Maps. Okay, just in case uh all right. Thank you very much um comms. This isn't a sub Brad on the call. If you could give us an update for comms yeah.

C

Sure so we have uh Carolina and myself here from comms, uh wanted to uh just yeah align with everyone on the the merged one that was for all the shift in so yeah. Obviously, that's a mistake. uh Generally, we do the feature box a day apart from each other, so um yeah just wanted to. Let you know that yeah. Obviously, we wouldn't want to schedule that, on the same day as the main release, vlog.

A

All right, thank you, yeah, so I have that link on the agenda. So there's um where the uh feature block for now, non-graceful node shutdown to ga uh that's already merged. So you have to rename the file as well, since the dates is also in the file name. um So you could open a PR exchange to change that uh it does not have to be the uh the author of the original blog post as well. So anyone could make that change and if there's, is there a project board as well?

A

So um this is an example of the 126 feature, blog tracking project board, if and I know, there's always issues with like um with if it's public or private, who can see it or not, um there's with all those permission rules, uh but if there is one, um if if we could somehow Grant I know, there's a sick, docs, blog approvers and then sick docs or a previous uh groups, GitHub groups as well, um if or could just share a status on the publication dates um for the 128 feature blogs.

A

That would be great because there are right now, there's three other open feature: blog PR's for 128. or two open, three open ones and plus the uh official release that will be, and it has not been open yet I believe uh so we have um so we have some scheduling to do for the feature blog. So if we could share that uh when that's ready, I think I did see a message that it might be uh still uh in the works in terms of scheduling.

C

Sure so, um if you go back to the enhancements for the old one, if you type in the links in the chat by the way as well.

A

C

Yeah there you go oh perfect, so this is yeah that comes View, and um if we go over um yeah we have the the PRS and then we can change this to. However, you want it um so generally, since 127, which now track it in here as well. Okay,.

G

Have you told the blog article authors, these dates.

C

Not yet no okay.

G

That that's like they need to know. That's that's an important thing. It's part of the role.

C

Okay, so I'll go to each one of these PRS and let them know the date and then um I'll do that straight away. Okay,.

A

Yes, that is very important.

A

um I do have a link for those uh open, PRS already, but I see the one that's been merged is scheduled for August 16th. So that needs to be that date needs to be changed on the on the header, the title and also on the uh the file name as well sure any questions uh for the consume or any questions for uh for for us for Sig docs from comms or Docs.

A

All right, but another questions, I, do one more request and I'll put this in the docs uh release Channel as well. If you could do one more sync um for the sync, the dev 128 Branch this week, uh that would be great and then um then we should be good for next week. I am available from release day, so we'll be available uh next week to hop out uh the docs team uh for these for the release day, task and uh follow-up task as well.

G

uh One thing I will point out and we recently emerged changed to a short code uh code and code new and a few people around the release. That's caused some confusion, people, people trying to Houston the newer short code, which is called code, but maybe their Branch isn't up to date yet and that merge might might change behaviors for people. So just something to watch out for.

A

That's a good thing to point out.

G

I'll add a note to the agenda. If you like.

E

A

Branches: okay, it's a good thing to watch out for it, especially you might have some errors on your preview or any other answers that might come up with you with your pull. Requests um might have to rebase.

A

All right, um thank you very much for to the one 2018 uh for attending and forgive us for giving us the updates today. uh I'll take a look at the open PRS for docs as well uh later today, um all right, so we can move on any other issues in PRS that anyone would like to bring up.

A

Okay, um next topic: there is a new GitHub discussion from Divya on localization, or did we opened it uh the uh localization contribution, docs, updates and terms of of how we will update how to localize or how do we create new localization, uh how the updates and how? What and uh and how, what that looks like so um I have the Lincoln agenda, which is open up here on my screen.

A

um So please take a look at that and uh please add your input on this GitHub discussion.

H

Yeah I wanted to say something to that.

H

Ray um there's also a link there that sioco has put into the GitHub discussion for folks to have a look at, which is the updated um um org membership um information and guidelines um and I just want to kind of say out loud to the folks here that, um especially in localization work, we like to recognize draft work, given that there's so much kind of lifting localizing content in especially specifically in new languages, and that the um the updated guidelines for all kids org membership has actually um underlined that draft PR's are are okay and that's something that we can take into account.

H

So I would just want to put it out there for other folks who are either working with localization folks and um who often find a hurdle on gaining k8's org membership. Sometimes that um draft work is definitely something that um is is valid in terms of showing um the work that you're doing and consistency that you're doing and now that's been updated in guidelines too. So just go ahead and really want to point that out for folks that um if in case you you're not aware.

H

G

I have another Point, um I suspect, I I. Maybe this goes without saying, but we really want if it's draft and it's under a CLA, then great, you know you've given it to us whether it's merge or not. If you haven't licensed it to us, I think it counts. Much less so cla's account yeah.

H

Big agree, I think I definitely still want to um uh put work in that still meets the require, like minimum requirements of K, AIDS and general contribution guidelines too, um but in terms of organ membership, yeah, like draft is, is okay as long as there's other under a CLA. Yes,.

A

All right, thank you very much any other comments or questions about this uh GitHub discussion on localizations or updating the localization contribution, updates, guide or guide.

A

All right next, there was an open, GitHub discussion. We opened um several weeks ago on the on General of AI for kubernetes docs, and it's been uh some good comments in that GitHub discussion as well. So please take a look at that. um I see Roberts Reeves uh from LF is here on the call. If there's any updates Robert, if you want to give, please feel free.

A

I

Did you see here yeah, just I and I'll, just speak to it. Real quick um chatted with Joanna Lee um effectively got the green light. um Cncf legal sees this as low risk um and I wanted to that. The team to know that you got lf's full support.

I

You got a cncs full support here, um but I just want to make sure that there's there's, that's not a blocker uh I know there was some concerns about it, so ran to trouble on that, and we got that sorted so um wonderful to see that you all are um doing that. I apologize, Ray, I, I, guess I didn't see that bullet point before I added my stuff. So thank you for starting that.

A

Welcome thank you for giving us the update.

A

All right are there any questions uh juicy hand up here.

E

Hey Robert yeah um is there so I know other people who are curious about that issue that you just discussed is there somewhere? We could find out more about that conversation.

H

Yes, in our meeting notes, uh I believe further down. We actually discussed this in a meeting prior a couple of meetings back there we go. Where um can you check that? Can you just show us the date of that Ray for that meeting, for we're all through July.

A

H

Perfect, um that was the first uh um instance of that discussion as well, so you can start tracking that, from there onwards,.

E

And is: is that kind of the authoritative source of this information, or is that derivative? um Do you know what I mean like I'm looking for yep.

H

um I would also look at the recording of this meeting at this as well. um Maybe the notes didn't capture absolutely everything, but the recording of the July 11th meeting, plus the notes are the source of truth. Yes,.

A

Well, I I guess I would ask if, if the cncf has any um public documentation for their approval, to use General AI or is.

E

There anything public.

A

E

I

um Not yet they are the this was they're working on that um Joanna did not want this to be a blocker, and the conversation was between her Todd more and myself that wasn't recorded.

I

um So what what can I do to help you all? What what would you like.

I

Because they're not ready to um thank you Natalie.

I

um They're not ready to come out and do the canonical here it is uh Joanna's view was like look. This is low risk I'm not concerned about this go forth as we continue to do what we're doing trying to get that canonical uh uh opinion out.

I

What what can I do to allay concerns.

E

No, that's that's great, that that helps uh with the context that I need yep. Thank you all.

I

Right happy to help hey, hey gang I work for y'all. So hey you need anything. Let me know you get it.

A

All right, uh thank you, Roberts Rolf, any other comments or questions about this topic.

A

All right uh next topic from Abby improving, outdated content, warning on localized content issue.

F

uh Yes, hello, so I created a an issue which now it seems I should have created a GitHub discussion to talk about this, but uh I can move that over if we want to do that. um So this is a new Improvement that was made recently um to the website.

F

So uh the there's a little automation that will check if a English language page has been updated more recently than a localized page, and if the English page is more updated or more recent date, then they will pop up this message on a localized page um and we were looking for a bit of feedback, uh so I'm one of the leads of the localization sub project, because the Korean localization has noticed some places where this shouldn't really pop up like uh when um spacing or something small has been changed on the page that doesn't necessarily impact the Korean localization.

F

This message will show up because the pages have been updated uh more recently in the English page, but it kind of presents the the appearance that the page is out of date, more so than it would be um when it's it's not actually date. The actual material content is the same.

F

um So this is just an ask for some feedback um on this um peace uh and and what uh improvements we can make uh to make it a little less, maybe a little less confusing for readers or appear in a more uh meaningful way on the correct pages that are actually out of date. uh So I just wanted to highlight this I can move it over um to a GitHub issue if we want to do it, if that's the best place to move that for that.

F

For this conversation to happen, uh but I wanted to raise uh this up to the group here.

A

Yeah, thank you for raising this issue up. Yeah I know there were several PR's that.

D

A

Changed a lot of the English uh line spacing or and so I think that might have affected uh many of the localization pages and I. Don't know if there's a possible change to the script to determine. If, if, if the line spacing was all that was changed,.

G

Okay, so um Hugo is definitely not clever enough to spot where there are white space. Changes is significant on offer or whether it change is white space only, but we could provide a tool that a localization team could run once a week, or you know whenever and say um this is going to.

G

um This is going to update all of the pages where the only missing thing is non-trivial white space and either move some white space around or do an empty, commit or whatever, and that will that will help um in some way. um Actually, an empty commitment might be like some sort of um important enough change. To do to do something, much easier to make that kind of tooling than have localization teams go okay. We know how to make the warning disappear. We'll do that and it is to teach you go to to Spot the Difference.

H

F

That might be something we can.

G

Look into I have another thing, so one thing we don't do anywhere in the site is have a shut up. I have seen this warning now, don't tell me about it for a bit button and there are some warnings where you might want to collapse them once people tick a box or you might want to hide them.

G

uh So some mechanisms where this is applied with this. This Banner here um this this warning. That would be one where people might say: yeah. Okay, great, but but you know just High collapse that now for me- and you know, for the next 20 days or whatever um banners on the website. Yes, I've seen cubecon I, don't need a an inch of my screen dedicated to telling me that it's happening um and a few other things um uh this this.

G

If you're, looking at the documentation for kubernetes 1.25, you kind of know that it's out of date and a small reminder rather than a big reminder is, is fine.

G

So there is a web development opportunity, not a bug, but it's an opportunity for someone to add a feature that that does that probably tracks it with a cookie- and um you know, makes the user experience better but tells them once.

A

Sorry I'm trying to capture this all right. Thank you very much yeah. That is a great opportunity. uh We do see a lot of folks who ask for uh ways to Opera ways to contribute to Sig, docs and uh folks with various different skill levels. So I think this is a great uh opportunity for someone who has those web dev chops to add a feature to the to the to the website.

A

All right I'll create an issue to add that or to make that uh open.

A

Any other comments or questions or any uh additional topics.

F

And I I will get that to you and a bit.

A

All right, I think that's it for our uh sigdox call for this week. um Once again, I want to thank the uh all the uh contributors who joined the call. Also, the 128 release teams as well um and I will reach out for next week's uh task for the 128 release. uh Just to remind folks, we do freeze the the kubernetes website, repo uh for 24 hours before the release dates. So you will see uh so you will see PRS, even though they are supposed to merge.

A

You will see them um just uh waiting until the freeze is lifted until after the release. So uh that's just a warning for everyone here that we will uh freeze the websites uh 24 hours before the scheduled release date.

A

All right so well, thank you very much and I will see you on slack and see you next time on the next sick, docs meeting.

E

Thanks everyone thank you. Bye enjoy.

G

Thanks everyone.