Jenkins Documentation Office Hours, 17 Jun 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 2021 06 17 Docs Office Hours

Description

Jenkins documentation office hours June 17, 2021 with topics including Jenkins Contributor Summit and pull reviews.

A

Welcome everyone, it's the 17th of june. This is the jenkins documentation office hours and reminder we abide by the jenkins code of conduct.

A

All right, so here's what I've got as proposed topics for today, so one is pull request review. uh That was if, if zenob had attended today, um I've I've submitted a review and no feedback from cynthia. Yet the other was contributor summit, preparation and dhiraj. I wanted to talk with you specifically about this one, because I just got one more volunteer for our session on next at next week's contributor summit. So this was what I was hoping to make our primary focus today. Are there other topics that anyone else needs to add.

B

No nothing from my side.

A

Okay, all right so um and there's, I guess, as a let's see as a matter of there's no docs track at the contributor summit, I will give a mark will give a status report, but we're not going to do a dedicated track for it, because we've got other things. We want to do with the time.

A

We're not going to attempt to change the roadmap at this point. The roadmap's already the biggest challenge for us with the documentation rob is making progress on it, not having a roadmap right.

A

All right, so um I'm gonna shift this pull request thing then to the bottom, and we can talk to it later if we'd like contributor summit preparation, so dhiraj, I am pleased to note that I had a conversation earlier today with aditya srivastava.

A

He says he's one of your classmates at the university there and he's also agreed to assist with the newcomer with the newcomer new contributor track.

A

And that's currently outlined, I think, as a 40 minute track dedicated to helping people contribute to jenkins.

A

Now I've got a new piece of information.

A

We now have over 1200 registrations for the contributor summit, so yeah, even even if 90 of them drop out that's still three or four or five times bigger than the last contributor summit. We did so that's, even if all we get is 120 attendees, that's still dramatically bigger than we've had before so delighted with that the cdcon registration process has done great things for us now. The question is how how do we want to approach the new contributors track?

A

So what I had proposed in the session earlier today, with hadith was mark create a slide deck describing some general concepts.

A

And then um diraj talk about his experience becoming a the changelog main writer all right, because there's something to be learned from your experience there and I thought that would be great for you to say: hey here's, what went well! Here's what didn't go so well! Here's what I could have learned better, and this is why this worked, and this is why this didn't then aditya has agreed to talk about his experience in infrastructure.

A

And advocacy where he's been participating as well now dhiraj, I thought it might also be good if you'd be willing to talk about the react, js opportunities, if you're interested, are you that that may not be? I don't know if that's yours, if that's a specific spot of interest for you, I know you haven't, haven't actively done any react work yet in the on the plug-in site or places like that. Would you like to talk to that? Or would you rather not.

B

um So what will be the eventual aim for this talk from my side.

A

So what I was thinking is, if you, if you were to highlight, uh highlight um several areas of the project that use react and maybe, uh for instance, the plug-in site, but the problem is you, you would have to get enough experience between now and then to say: yeah, I'm ready. The other is, I could ask, could ask gavin mogan.

A

To share I'm just not sure he's going to have time.

A

Okay, are you if and if react is not a passion thing for you if you're just asking for somebody else, let's not do.

B

It I have contributed like a small prs to the custom distribution project and all of them were based on react.js.

A

B

So I can talk about that and, uh as you said, the specific uh focus should be on the plug-in side, so I can so we still have some time. So I can research more on that, like on plug-in side where react.js is used, so I can talk about that and so will gavin will be able to help me. As you said, he is busy. So.

A

Well, it's I even if that's a good point, even if all you talked about was your submissions, the custom distribution service. That's already a good way of saying look here, is a very specific example using react.js that I submitted, and I didn't do any java. I didn't do any any anything other than this was a react.js project.

B

Right, I can do that totally.

A

And if, if others are, if other things are, are available, great, that's optional, just having the problem for me is. I cannot. I cannot reasonably talk about react.js contributions, because I am, I don't, contribute react, whereas you do. I can talk about java and I can talk about documentation and I'm actually credible in those two areas, but I am utterly not credible when it comes to react, so it would be great if you're willing to share hey, look here's what it was like for me doing this. It's it's not hard. You just do these things.

B

I would love to do that. Definitely.

A

Great all right, we will put you on that list, then excellent.

A

A

Good, so you you should plan you'll, probably have between five and ten minutes between those two things total so I'll I'll send the slide deck. You can put your slide. What you would like to say is guidance into it and then we'll just have you share.

B

So can I also get the information about what particular time number that I have on this week.

A

So what I'll do is I'll mark place, insert placeholders in the slide deck.

A

And assume what should we assume we got a total of about? I think we've got a total of 40 minutes. Maybe let's outline the agenda here so um 40.

C

A

So in the 40 minutes, what I'd say is: let's do maybe we say.

A

10 minutes of general and opening of opening in general contribution so java and docs, and then give you five minutes on weekly changelog aditya five up to five minutes on infrastructure. And then would you willing to take five minutes on react, or would you rather have more than that.

B

I understand there's a lot of things that we need to have in this small time, so I am good with five okay.

A

Great all right and then I would think we want question and answer for probably 10 to 15 minutes so that if people have specific questions, they can ask them and we can help with them, and I think that takes the whole time yeah. So that would be the the 40 minutes.

A

I like that, I like a lot having different voices, especially not my voice, so that's great diraj. Thank you very much for being willing now kristin. I would be happy to include you in this. If you would like.

C

um If you need me to talk about anything, I don't really have much to say again. I've been trying to like focus a lot on um gsoc for this like period of my open source life, um but- and I would like to get back into this- maybe in the fall, um because.

A

C

Some general, like ideas of what I think could be maybe help get people to contribute or to encourage.

A

C

um But yeah I just well, it helped with the last one and there really weren't too many people that came to our breakout session. um So I can also help if we're, if we'll have a breakout session too documentation. But I don't really have much. I have unfortunately not been as active as actually producing documentation.

A

That's great your your focus on gsoc is deeply appreciated. I am so pleased with our results from google summer of code uh when, when oleg sends a status message and says things, look like they're going well. That is really high praise. So, yes,.

C

Yeah I say exactly it's like: I want that to go well this summer, so I apologize.

A

C

I'll try to be more active after that period,.

A

No, no, no apology necessary! That's that's great! That is absolutely wonderful! Okay, good all right, so I will send you I'll send send the link to the slide deck and jiraj you, and I will also discuss it. I assume at our tuesday office hours, if I remember correctly, you're still available for next tuesday. Is that correct.

B

Definitely yes,.

A

All right, great.

A

Excellent anything else we need to discuss on contributor summit any areas of concern diraj for you or things where you're worried about this or that.

B

Well before this, I was concerned about how I'm going to contribute. So now I have clear plan about what I need to speak, so I'm really happy. Okay, great.

A

B

So this 40 minutes is for given uh this 40 minutes, giving us for the documentation or just full contributor summit, I'm not sure.

A

Well, so the the 40 minutes is for, let me bring it up. The 40 minutes is for the track. That's focused on new contributors, so here I'm going to bring up. This is the schedule draft.

A

Let's put it in the links draft graph outline.

A

And then the draft schedule and the schedule is the more detailed thing. The schedule is a a sheet that.

A

Olivier bernin has been assembling so, and I don't know if you can see here. Let's make the text bigger. Alright so starts at 9 a.m. Eastern time, which, if I remember correctly, is about 6, 30 pm or 7 pm your time then we will. We will be on this one right here, so this row contributed contributing to jenkins.

A

We get 40 minutes and it will be you and me and aditya and we'll lead that session. Ours will be running concurrent with a plug-in end-of-life policy session that james nord will be leading, and then we will end and switch to other topics. Like me, I'll probably go into the next session, which is outreach program and then the next one I'll attend is java. 11.

A

does that? Does that answer your question.

B

Yes, no, it makes sense.

A

Okay, great so let's put this.

A

Yeah so, and we've got we've, we've done many of these presentations on how to contribute the. For me, the distinction of this one is your voice, dhiraj and aditya's voice, rather than it being my voice and I'll use I'll bring in some of the old materials some of the previous materials I've used, so that that'll be basis, but really the I think the most interesting is hearing from brand new contributors saying yeah. This is what it took for me to become a contributor.

A

Aditya is working a google summer of code project. Here you are working documentation and helping with react work on on the distribution service. So I think those are really interesting.

B

Yes same here, I think that will encourage other other students or other newcomers to contribute, as well.

A

Good, very good, okay.

A

All right, then, then, that's that's what I had and I see the only other topic I had for today was the pull requests that are pending for the jenkins documentation site and here, if we look at those.

A

There was this one right here from cynthia one of our chico africa contributors and I've given feedback, and I don't think she's seen it yet so so nothing really to do there and others. Oh this one is a major one that uh why our sudakar had done that I've done initial reviews, but it needs reviews from other people.

C

Right: okay, good, I saw that tim was on the as a reviewer and it's like. I really think that tim would be one of the best reviewers too.

A

Right on this absolutely well and and I'm as I'm watching in the plug-in installation manager getter channel, I'm realizing that there are probably more use cases that should be flagged in this to be described in this, then are currently described. So so it's such a broad thing and plug-in installation manager tool is so capable of so many things that that this document is even more important than I initially thought it would be so yeah crucial.

C

Okay, yeah, it's like. Can we start with something small and then, if we find some cases, where should we flag those like it should be open a?

C

I want to be able to record them. um Where should we open something, so we don't lose them like? Is it going to be a something in the plugins installation manager tool like backlogger? Is there something we should put in an issue in jenkins, io.

A

A

Documenting it here, I would create an issue, an issue in the jenkins site, io site for the documentation of that okay, but now that there isn't a page yet to even associate it with, because this hasn't been merged. So for now it could just be in the poll request.

C

Okay, just kind of put it as another comment but yeah. I.

A

Didn't want it.

C

To turn into a you know, the pull requests that can never close, because we just keep finding more um right.

A

Right and and that's and that's a valid point, and I think I think we want to get this thing over the line right.

C

A

Add to it absolutely.

A

So let me let me put a note on that one. So pseudocars oops.

A

Pr4 plug-in installation manager.

A

Okay and then the one for cynthia was this one, and this one actually has an interesting side side challenge that maybe it's worth exploring with you kristin what cynthia's pr does is. It takes a very we have an issue reported here redirect this page from the wiki page to the doc site and those are good things to do, because it's removing content from the wiki. So that's that's a big plus.

A

This is a tiny piece of a bigger picture story. This one is just a little bit of warning about. Don't try to start agent.jar without arguments it doesn't, it doesn't behave the way you think it would.

A

The bigger picture is this page on using agents is, has very little in it. It only does docker. It has nothing about static agents, nothing about ec2 agents or azure agents or or kubernetes agents or openshift agents and so agents. Is this great big, open space and.

C

A

What her change is going to do is it's going to add one more section to the end of this thing. That's a very specific thing, and but it's not. We've got a whole lot of more work to do on this page, but.

C

A

Thought was okay, one step at a time. We'll do one little thing and then do the next little thing.

C

Right: okay, um if it's, if, um if it's taking, if she's, not able to come back to it, maybe in a couple weeks, um is it possible for one of us to just cut? Can we commit to the pr? Oh.

A

Yes, absolutely yeah. In fact, I I described that to her in the pr I said.

C

A

I I gave her my apologies. It was two weeks that it sat without me reviewing it and then I finally.

C

A

It and reviewed it, I said, hey so sorry, uh but if it takes you more than a few days, I can. I certainly have the permissions to go in and make the few changes that are needed.

C

Okay right yeah, because sometimes you know you go, I think she's a student. You know go back to school and maybe um time.

A

C

Right, you know like next thing, you know it's been a month um and you're just in class, and it's just a lot right.

A

Exactly well well and and it's what she's done is helpful and therefore we don't want to just let it sit if, if in a week or so, it hasn't been merged, I'll, probably just make or hasn't been modified I'll make the changes and then merge it. And that way we can close the issue because it gets an issue off our backlog. Sure, okay, good for.

A

And and dhiraj one of the one of the topics in our talk in this general section that I'll do is docs migration from wiki to www.jenkins.io.

A

And another is docs migration from let's call it this way: plug-in docs migration to into plug-in repositories and those two topics, those two topics alone: we've we've done one-hour webinars on each of those. So there's plenty of plenty of work to do in both those areas.

B

Yes, there are lots of issues on this one.

A

Right exactly all right, so I think we talked about pull requests. We could do a further look, I'm not aware of any any large open oops. Here we go. Let's find.

A

Yeah, so there are.

A

Some relatively quick ones to review and.

A

ah Yes, here's one! That's coming that dhiraj! You should be aware of.

A

There will be a weekly release of jenkins at some time in the future that will declare boldly that certain plug-ins are no longer supported, and uh this non-java plug not plug-ins, that are not written in java, and we have several that are written in ruby and one or two that are written in python and the ruby runtime has been problematic at all sorts of levels, and so we are finally admitting that we're going to stop at some time in the future supporting ruby, plug-ins based on the ruby, runtime.

B

By supposing you mean that there will be no bug, fixes and feature enhancements right.

A

No meaning they will just stop working it's. This is even more dramatic that this we are the the liability of carrying forward. This thing is so great, for example, it doesn't run correctly on java 11.

A

and we're confident it will never run correctly on java 17., and so it's just not it's not a it's, not a viable thing for us to bring it forward, and since it's not viable to bring it forward, it's just time to admit we're not going to to attempt to maintain this thing anymore.

B

Okay, so if people are using some ruby-based plug-ins, so uh how are they going to deal with this? Do they have any information.

A

They will have to look for alternatives, and, thankfully, most of the almost all the plug-ins have a very tiny installation count and a very a small installation count or are so old that they've long ago been replaced. So, for instance, this one last released five years ago and there are several much better choices than than that. uh This one likewise cucumber this one. Likewise so each of these- and it isn't until we get to really tiny installation numbers way down like here.

A

If I remember right where this one may not have a replacement, but it's so old and so untouched that we think there are very few people who will be harmed.

B

A

Yeah so, and now that when that happens, hasn't been finalized yet, but just be aware that there will be a weekly changelog coming your way that says: hey, we dropped this and there will be a blog post to go with it.

A

B

And, um as you said, there's going to be some sessions on uh migrating. The key dogs to jen jenkins.

B

So on that, um as you said, there is going to be some prices for top five contributors, so is it still there.

A

Sorry say that again, there's going to be.

B

Yes, so there's going to be any kind of competition, like top five country, will get some swags or something like that. Oh.

A

A

So is: is that what you're asking about is, will there be? Will there be yes? So that's a good question and- and I've still got an open question that I have to answer with the the organizers open question on how much swag we can send and how we choose.

A

Recipients so, for example, one of the one of the ideas was, uh we may just be able to send swag to those who present uh or we may present, send swag only to the first 50 who join or something like that. But that's the continuous delivery foundation correctly observed. They cannot afford to send a t-shirt to 1200 people.

A

That's that's just more budget than they've got to spend.

A

Mark to find answers to the swag questions soon.

A

Anything else on contributor summit.

B

Yes, so the video, so the presentation is going to be live or I'll, be recording a five minute and sending it to you.

A

I had planned to do it live. Are you okay doing it live.

B

Definitely that's a great. I love it.

A

Okay, great all right.

A

I mean if it would be dramatically easier for you or, if you say, hey I'll, be sleeping at that time. We could record it, but for me making it live, allows you to show and then allows people who are observing, who are watching to ask questions and interact with us.

B

Whoa, okay, so there's going to be some questions.

A

Afterwards, yes, so at the end of the 40 minutes, I hope to spend at least 10 minutes doing, questions and answers.

B

hmm Right: okay, that's great.

A

A

Oh and- and I should say it live per se, it will be a live presentation, but I believe we would also intend to record.

A

It for later sharing so don't don't, show something secret or confidential on the screen. It will be.

A

Remembered anything else we need to discuss.

B

Today, so in coming tuesday, there's going to be definitely a weekly law, so I was trying to uh I'm trying to ask you when is going to be the next healthiest change of practice? For me,.

A

So the so this coming to this coming tuesday next tuesday, will be another weekly. So that's that we'll plan to do that as a change log and we will in next tuesday's session if time allows we'll go through and I'll do the lts change log so that you can watch and ask questions so I'll. Do the 289.2 change log during next week session?

A

Did that answer your question, or did I ask answer the wrong question.

B

Yes, you answered it correctly, so just to cross the lts club that you're going to do it's going to be done next, tuesday or thursday.

A

Next, so I'll I'll, dr I'll, create the first draft of the lts changelog next tuesday in our office hours. This session next thursday will be cancelled because it will collide with the continuous delivery conference with cdcon.

B

A

It's a good good reminder no meeting next week.

A

Next week, cdcon is.

A

Next, let's call it this way: no meeting next thursday or what day of the week is it for you right now? Is it friday, raj or thursday.

B

Well so it's friday.

A

Yes, okay, so next thursday slash, I have to have to remember where we are in time zones, so you've already reached friday your day. Okay, yes, all right.

A

Any other topics.

B

um Nothing from my side.

A

Okay, then, let's, let's call this a done session thanks very much and talk to you again on tuesday, dhiraj I'll, send you a link to slides before then and we can collaborate through the slides as well sure.

B

Looking forward to it.

A

All right, thanks very very much.

C

A

Bye, everybody.