Jenkins June 2021 Contributor Summit, 25 Jun 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Newcomer Track Documentation

Description

Jenkins Contributor Summit June 25, 2021 Newcomer track - Documentation

slides https://docs.google.com/presentation/d/1eU0KabpBtGd0BCebuhWyvBgBunBaZvM3hIfcpdy_-OE/edit?usp=sharing

A

So let me start so.

A

My name is yoda, as I told you before, and uh right now we're going to learn about the change logs week, weekly change logs and I'm going to share my experience of working with it and uh how I went about it and everything from start to end, and uh so, as you can see on your right side, this is a snippet of the weekly change law that we at jenkins write and the reason behind writing these change logs is that we release our new jenkins release on a weekly basis and on each release.

A

We have a new uh bug, bug fix or a feature enhancement that the developers do and uh what this changelog does. Is it compiles all the things that the latest version of jenkins uh shows and releases and just beautifully documents it on the screen?

A

And if you want to check this out right now, so you can go to your uh browser and just write down jenkins dot. Io change logs, so you'll be able to see all the change logs so now, so these are basically very user. Centered description. What I mean by that is that uh each of the point is written in the order of priorities, and there are some set of rules in which we follow in order to place all of them.

A

So the main aim of here uh our aim is that the developed developers should spend less time to understand everything and at just a one glance that they can understand what is new with the current release. So, as I said, it's released every week and it's definitely human edited with tooling help.

A

So I use a tool, uh it's a docker tool which is used to compile all the pull requests that have been submitted right from the previous change log that was released, and then I uh edit it in the form of by following the style guide that I was mentioning the set of rules and then just compile it and then send a full request.

A

So yes, so this is a very important part like I. I really want to share my experience here with everyone, so that uh if anyone is interested to know the process behind it or they want to contribute that, then it will be really helpful. For you, so I started to uh join doc's office hour. uh It happens every tuesday and um thursday as well, optionally, indian standard time and uh yeah.

A

So I joined them and I interacted with mark and everyone, and then I watched some videos where mark was so showing how to write change logs and all the videos are available on youtube channel as well. So you can watch me as well doing all those change logs one by one, so it will be very easy for you to refer them and uh just review the recordings and then generate it on your own on your local machine and then just simply submit a full request and uh it's it's not complicated.

A

That's what I'm trying to say here because uh as um also asked us about what's the requirement of uh java that we need to have in order to contribute to plugins. So similarly, here as well, if you talk about the requirements here, it's not something you need to not to be an expert you just need to have wish to. You know, do some meaningful contributions here, so it will be really great. We can use your help here.

A

So yes, so now I would request aditya to share his experience with us.

B

Thank you deeraj uh before that. There's another question for you in the chat by jyoti. Again so I'll read the question for you: can you share? How can I join docs officers? Is there any meeting link.

A

Awesome so there's a getter link I'll. Yes, that's a great question. So so, if you can see my screen, then okay, I'm trying to understand how to.

B

We we are able to see uh the better channel if that's what you're trying to do.

A

Yes, so this is the link that you want to: click on and you'll be redirected to the place of getting channel for docs office r. Is there any meeting links? Yes? So also, you would also love to know about.

A

uh No, I think it's calendar yeah even calendar for jenkins, so this website tells you all about the upcoming events that we have, and it will tell you that when is going to be the next meeting for jenkins docs officer. So currently we are here, so you can see. There's a lot going on today, due to contributor summit and uh so you'll be able to see everything here. The details of timing and everything so I'll share the link with of this as well uh in the chat.

A

So this is the calendar that you can refer now. Thank you for the question thanks. So.

A

B

Thank you peter, so hello, every.