Jenkins Online Meetup, 14 Oct 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Hacktoberfest: Docs and more

Description

Jenkins Online Meetup for Hacktoberfest 2020. Includes suggestions for areas to contribute including code, documentation, and more. Provides a demonstration of building the jenkins.io site locally for development, examples of submitting pull requests from github.com, and a migration of plugin documentation from the Jenkins wiki to GitHub.

A

So welcome everyone. This is the jenkins online meetup, it's the 14th of october and we're celebrating hacktoberfest this month. This is the docs and more uh presentation we're going to share with you how you can contribute to jenkins as part of hacktoberfest.

A

Hacktoberfest is a great experience and the jenkins community has used hacktoberfest for a number of years as a way to help people as they can want to contribute to jenkins and to help open source. So, let's talk about who our presenters are today.

A

First, we've got omega. Oleg isn't based in switzerland. It's an international community today presenting he's a jenkins contributor he's a member of the jenkins governing board. He's been involved with jenkins for many many years and has contributed significantly in many many different ways. I'm mark waite, I'm based in colorado in the united states. I've been involved in jenkins for a number of years as well. We've also got jonathan morais with us from brazil.

A

Jonathan is a contributor to the documentation special interest group with interest in code and how to do effective documentation as code he's been a great help in the doc special interest group. We're so grateful for him. We've also got vlad silverman joining us. Vlad is here from california and we're looking forward to his presentation as well.

A

It's great to have all all of our presenters here. We love hacktoberfest and are grateful for it. It's good thing for us. It's a good thing for you, thanks for being willing to help us now today's agenda, we're going to have me. Do these brief, intros and then oleg's going to share several different ways that you can contribute to jenkins and hacktoberfest jonathan is going to then highlight some of the things we did to prepare for hacktoberfest, so that you would have a good experience after that.

A

Vlad will talk about how to build the jenkins site locally so that you can do documentation test and evaluation on your own computer, and I've got some session ready to show how you could do plug-in documentation, migration from the wiki to github and, at the end, we'll do question and answer now. What we'd like to do is encourage you to ask your questions using the webinar q, a system that helps us so that we can answer questions we'll choose to answer them live or answer them in chat.

A

We are open to your questions, open to suggestions and ideas and at the conclusion of our session, we'll stop the recording and then invite you to talk with us directly oleg. I think we're ready for you. Okay,.

B

B

C

Did we go through this slide already.

B

Okay, let me just cover it um so yeah october, 1st 2020 is quite an exceptional year, because this year the vast majority of october first happens online due to obvious reasons.

B

Even before oktoberfest was a worldwide event during one month the hundreds of various events happening across the world and everyone was able to contribute remotely as well this year. The main focus is on remote and basically the framework remains the same, so you can submit four pull requests and after that you get a t-shirt um or now you can plant the tree or somebody transfer the tree for you very cool correctly.

B

So it's your choice, and but the idea is quite simple, so you can just click a button start hacking register by signing up with your github account, in my case, I'm already logged into github. So for me it will show my profile. I guess. But if you go here for you yeah for you, it will show the signup form where you can register and after that you can start contributing.

B

Basically, that's it, uh though there is some specific central use for this year. We will talk about it later.

B

Okay: um let's talk about the the genghis project, specifically uh so jenkins, as many other projects participates in oktoberfest, we started participating actively in 2016 when we published a special page for october. That's when we started preparing newcomer friendly issues and promoting the event, and since that the project has been successfully uh participating.

B

In october, 1st we've got many contributors joining the project and the community during the oktoberfest, and we invite everyone to participate.

B

Your experience with jenkins doesn't matter. There is a lot of newcomer friendly issues. The result of pacquiao is uh focused uh not only on court or documentation, but many other activities. Basically anything you can submit as a pull request that qualifies for breakfast.

B

So this year we are happy to introduce a number of featured projects and also a lot of issues which have been prepared before the event, and we will talk about them today.

B

Again, anything counts, so oktoberfest is built around github.

B

Any repository which is public on github is a digital for oktoberfest if it's configured properly so what it means that all the code, the communication and also many escort instances, for example, infrastructures code documentation, is called and many other areas which you can represent as code and find on github. They are also eligible for photographers. There is no specific differentiation for that. In the case of the jenkins project, almost everything is stored in github repositories, so, basically, all content. We have design wall artwork, of course, all the code test units etc.

B

All of that is available as code, and hence you can contribute many perceived jenkins as java project and, yes, the most of jenkins is written in java, but actually it's not only about java. There is a lot of other technologies. You could work on if you're interested last year, together with smart, we did a presentation about uh contributing to jenkins, and if you want you can go to that. uh It's probably.

B

I can share the link in the chat later and there you can find a lot of information about what actually interests you and uh for jenkins. We use it's a robust system with uh hundreds of plugins with mining infrastructure repositories.

B

Basically, for many areas you can find existing projects so whether you're a java developer a go developer.

B

If you want to try front-end or if you want to write some documentation, you can find something interesting for you and if you're interested in a particular technology, just contact us and we will be able to provide a few examples today, we are talking mostly about the documentation. So let's go quickly to the documentation, part, okay, so yeah. You can find some examples here in this slides um javascript go long, uh many other languages and yeah. Today we talk about the implementation so for documentation in the jenkins project we use markdown and ask doc.

B

We have a lot of repositories using mark down as github flavor markdown as a documentation language. uh The jenkins website is allegedly written in a ski doc. I believe today we will cover both technologies, so vlad and jonathan I will talk about ascii doc, based documentation. Mark will talk about a markdown based documentation, um so yeah. We will cover that in addition to these formats, we also have a lot of embedded documentation, our components and there you can find a lot to play in text plain html and other languages.

B

So again, any repository can be a good fit.

B

Sorry for this tutorial, let's finish with the main presentation, so that we have more time for coin later. Okay, why to contribute.

B

I mentioned uh multiple times that uh any repository would qualify, and yes, that's true, but at the same time, especially for newcomer contributors, it's important to have clear guidelines, uh issues etc, and we did our homework before the heart photographer started, and we prepared a number of newcomer friendly projects to which you could contribute, and all these projects are considered to be very important to the jenkins project and the community. Many of them are represented on the public changes throughout the month.

B

So it's not like. We found some areas where a newcomer friendly, I think it's uh by contributing to these projects. You actually contribute to the changes, project goals and they have some examples. So there is jenkins website with a lot of ongoing documentation, improvements and the restructuring that is jenkins core, which basically a foundation of any agent instance running. Then there is a plugin site which lists information and documentation for all the plugins. We provide from the jenkins project that is jenkins file, runner uh portable class engine.

B

There are a few plugins listed, for example, primitives plugin. Actually we don't have any other plugins listed here. This features projects but yeah. There are other plugins come up from the issues. We will talk about how to find them later.

B

Also, we invite everyone to participate in terminologically now, so we think of agent controller terminology and the other areas. There is a lot of quickbook requests, so you can do there again. It helps the project. Also, if your designer in jenkins, there are multiple ways just to improve the look and feel, for example, you can just contribute artwork, which can be used in web interfaces on the jenkins website on community projects. Also, if you want uh to improve the existing uis, you can contribute to themes.

B

For example, there is a recent dark theme for jenkins, which has been created several months ago, and there are other themes or you could just contribute to core jenkins uis. All of that is possible and yeah. What else do we have as featured projects? If you are one of kubernetes, maybe you have recently moved jenkins home charts at the jenkins organization.

B

So now it's a part of the official jenkins repository and we invite everyone to contribute to the version 3.0 of these charts, and there is a lot of different activities and issues available and also that is ongoing projects for plug-in documentation, integration.

B

It has been available even during the previous october first but yeah. There is still hundreds of plugins to move, so we will appreciate on contributions there. So all these projects are not just uh tables. You can find that for every project we have published here, we have clear contributing guidelines list of good first issues. You started working on and also a list of other open issues and documentation which may help you to get started. So you can take any project which is interesting to you and just start working on that for new common contributors.

B

It would be the recommendation just start from one of these projects. If you want to find more, as I said, not everything is listed as featured projects. We also have a number of issue: queries uh where you can find um issues suggest hot photographers, so, for example, uh injectors jira, it's the old box writer for the project. You can find oh just three issues marked for oktoberfest, but likely we will.

B

We need to do some scrap there, but, okay, if you go to github queries, so many new components now use github as the main issue tracker here, you can find more than 50 issues focusing on different areas, so you can see that there are some plugins which haven't been listed, for example, azure keyword, slack plugin, configurations, code, plugin picture client, etc, etc. So you can find more projects where you can contribute here and also, if it's not enough, there is a. There are also common newcomer, friendly issues which haven't been solved specifically for hardware breakfast.

B

So here I guess we have several hundred issues and even more good, first dishes on github. All these issues should provide enough information about how to get started and how to contribute so take a look at them and we will appreciate their contributions to all these areas.

B

Did we get any questions so far.

A

We don't have any questions that have arrived yet now. I there is one table that I've enjoyed, that is the table of fresh issues for uh or of new of newcomer friendly issues on jira. That shows things like the get client plug-in. Has a newcomer, friendly issue to help me translate tests from junit 3 to junit 4, so you had noted all like individual plugins may not say: oh I'm a featured plugin, but they they are still very welcoming to contributions on these newcomer friendly issues.

B

Right, so we have hundreds of active repositories in our organizations and if you contribute somewhere, you can get initial feedback and reviews, and even if you don't get feedback immediately, it's still not a blocker from contributing there, because we have a process which still allows to mark these contributions for oktoberfest as a legible request.

B

Okay, let's actually talk about that.

B

Okay, so let's get started if you want to get started with oktoberfest again, you register on the website. As we discussed before, then uh we recommend uh to join our guitar channel. This is the channel which you can use for any kind of koni.

B

uh So if you have any questions, if you are stuck, we give further some problems. You would like to start out. For example, you don't get reviews etc. uh Please let us know here and we will uh process it and help you there and basically that's it. You start contributing for contributing um again any request to any github request repository accounts, but this year there were some changes in the program uh due to which traffic of spambo requests coming to other organizations.

B

So how to professor our team modified the process, and now it's opting for photographers contributors for that we added additional process so that when you create a pull request, we need to know that it's related to oktoberfest, so that uh the hackfaberfest team can uh mark it properly as oktoberfest accepted pull request so that it counts towards your oktoberfest goals.

B

I'll show you how this process works again. Let's just take a look at our featured projects, I want to do something quick, but at the same time useful to the project, and I think that terminology cleanup will be a good example. So here you can see that there is a link to epic for aging terminology cleanup with open issues and contributor guidance. So we can start from here- and here there are a number of newcomer friendly issues.

B

Let's just launch this github query, so basically it searches across jenkins, github organization and looks for usages of slave terminology by default. We want to clean up everything.

B

Still there are some scopes, so, for example, here you can see that some usages are related to code and to api, so these parts are quite challenging, but there is a there are also documentation parts. So, for example, I can just filter by markdown and it will show a lot of documentation.

B

So here you can just browse from through that and we can find a component which we would like to update. So, for example, there is a copy to slave plugin. So let's take a look at that and see. What's in the current state, so there is a short page here which basically summarizes what's the plugin about, and that is also a wiki page and I guess wiki page hasn't been getting related to github, so something mark will be talking about later so yeah. This is the actual documentation.

B

But let's imagine that we want to clean up this repository because it's a valid uh request- and here let's take a look: what's the current model plugin, so the current name is copy to slave. We can assume that it should be renamed to copy to agent.

B

Now, let's try to create a pull request for that.

B

B

Again, I will be just using the github web interface, so no id needed nothing uh except your github account. So here you basically look for all the usages of slave in the main page and we can just replace all of them, so this one we can attach, because for this weekend this one, I guess we can just remove it, because it's 220.

B

the source code.

B

So it's now only on github, so we cleaned up some references. So what else you can do here, for example, uh okay, let's keep it as this. We can update it more, but we wanted to just rename this. So this is what you're able to do for now, and here we can say that clean up slave references.

B

Okay, so this is uh my first patch just submitted and create full request automatically so here uh so we need to mark it for oktoberfest so that uh we can discover it on the organization level. So I just put charcoal first vlog and I guess that's it.

B

B

B

So I created this request and yeah, basically, this already a contribution which may help users visiting this page, and we can assume that it's a valid hardware first contribution. So what will happen? It's not you doing that. It's uh orcadmin handling that we put oktoberfest accepted, pull request so that the pull request becomes legible for hardcover and that's it. So we have created our first request, which does something very useful. Obviously you can find much more examples for that in your plugins. I just wanted to show a concept of how you could do that.

B

B

Let's see, there are more ways to contribute. We talked about featured projects, we talked about queries, but actually we are not limited to that. uh There is a page called jenkins, ios participate, it integrates information about always to contribute to the project and if you are looking for more opportunities, please refer to this page.

B

So there is a guidance, for example, for contributing code, contributing to documentation where you can find more references, more various references to other ongoing projects, so, for example, in the documentation seek, there is a number of projects related to the junctive documentation, and you can find it here, it's also from the page somewhere so yeah, for example, jenkins on kubernetes insight, integration, begin documentation, user guide, rework, etc.

B

So there are more arrays where you can contribute to, and you can explore to these guidelines to find these projects or you can just ask us in the github chat, and we will be happy to help you, okay, more advanced projects, basically any pull request to any jenkins github organization accounts. Also, you can contribute to upstream projects. Jenkins uses hundreds of different upstream projects, uh honorable mention apache mavian, including tools also many other apache projects we use in our code base, basically for many other projects uh which are part of fujavaca system.

B

Also, if you want to develop dotnet code, we don't have dotnet code right inside the junkies organization, but that are projects we use like windows service drivers for managing windows services. So you can take a look at that. You can also work on your own repositories, for example, just create a demos for jenkins do some more experiments. For example, this jenkins configuration is code, his helm, charts series, kubernetes separator and these other new technologies available in the jinx, and you can mark this repositories for helpful very first.

B

You might make them discoverable for others so that they potentially help other users. Of course, you can also catch your junkies pipelines, especially if they're in open source projects.

B

In addition to that there are cdf projects, you can also take a look at them. So thank you. Is the liberty foundation operative space and hardware test as well, and if you want to find more information, please hear links for all the cdf projects, so here you can find the guidelines etc for all of them.

B

Okay, that's it from me and if you have any questions, please ask in the chat. I will answer them. I think we should slowly move on so that we can go through the entire gender.

A

Thank you jonathan. You ready. Let's see oh like, I think you need to continue sharing your screen so that your the slides are visible. That's great yeah and ready.

B

Okay, let me do that.

D

Can I start.

A

Yes, please jonathan, go ahead! No! Okay, okay,.

D

So guys uh hi everyone and my eyes on this view and software developer, and I I love when my daily tasks can run for themselves. So because, then you are jenkins and I have been able to hear jenkins fights since early 2020.

D

So I'm quite new here too, as you uh I started just a few times ago, and I'm here today to show you how we prepare everything to offer you a better experience than actual respect. Okay, so first everything I would like to say thank you for you all and we already received several pr's and a lot of new makers joined to our community and this month, and they those pr, has really helped us to improve our documentation and offer a better experience to our members community too.

D

Okay, so just to show you a big picture uh about our preparation, I will show you some charts. So, as you can see, the yellow, uh big, yellow slice of the chart show all issues we have to work early august, okay, so we mark and others map all issues for all pages from the older week. We we have and how uh they are important for their own visit, page okay, so once market uh we work hard to open all issues or github, so can move for the next shortly.

D

uh So in the next chart you will see the difference. uh uh Hello mark.

A

Oh, like I think you need to go back one. Sorry, sorry jonathan! I think, oh, like you need to go back when this is no. No, that was no. You were right august 2020, you were correct. Sorry next slide was yeah.

D

A

Where we're going there, we go.

D

Oh, this is the one now yeah in the news chart that you can see and what we work to finish some issues, so the green ones show every issues we already migrate for the new site. The jx.io and the orange slide shows how of uh many available issues we have so uh five august to now. We have almost 150 issues to work on it and maybe left now, because we already closed on them because they, after after request, but the most important, is almost 50 items as.

D

Issue, so there is two important points here. The good first issue is uh it's where you should start to contribute to gender okay. So if you need to learn how github works, so if you need to learn about process- and you want to know how changes work and how uh get best from the software and the documentation is that that's a start point to you, okay, yeah. So for that reason I start work on uh jake's documentation too. I'm a software developer.

D

I can work for another plugins developers and other things, but I choose documentations because, yes, okay, it's a good way to feedback for community for everything documentation we already see on the internet. So uh it's good to you with a good place to stay and switch back.

D

Okay, so just go to github so to go to the main poster of jenkins: go to jenkins dot, io eclipse click on issues, tab, okay, so there you can see all issues we have available to work and click on the blue one inside then, which is right a good uh first issue to start okay. So here, in that slide, we have have a a print for a software issue. Okay, so once you click on issue to set uh us work on them, you just write a comment, so just say on comments I work on.

D

I would like to work okay, so there is a lot of good content there. So when you pick an issue yeah all you need to start work with all that, but if you need some more assistance uh feel free to to ask for help. We stay there to help you, okay, so inside this each issue has a video required by mark where you can find how to work on documentation and how to be great, a page from the old site to new one. Okay.

D

There is a lot of other information too so take time to your time to read on them. If you find any questions just sent over, so the issue is good. First, one is your start point. Okay, um another important thing to know is the another on other issues: it's more complex, but not so complex at all. So once you watch the videos by the issue you are, you are ready to work on jenkins, documentation and migrate. The the page, the only difference before uh between the first good first issue is a normal issue.

D

It's because some of our contents are it's it's not up to date, so we need to rewrite the documentation, update the content. So in that moment, so you will learn more about jenkins and contribute with communities. Okay. So to do that, you need to set your environment, and this as a vlad, will show you the next session, how to set your environment, how to create uh your first vr and how work engage documentation.

D

So everything uh you need to know to start vlad usual to you. Well, uh so at the end, uh I hope you all reach out uh new 40 years to to earn you the shirt or even better, to first to place a new tree on forward and it's important. They are alert about nature and a lot of things.

D

As I said, I'm from brazil. So here we have fentanyl. We have amazonia and uh I I can tell you guys. We need more trees to stay and help a world to our children. Okay, so thank you guys. Thank you for your time, thanks for participation, and I'm done here mark. Thank you. It's on you now.

A

Thanks very much jonathan, that's wonderful and yes, the plea for more trees is a good plea. That's the right thing to do exactly. Thank you. Thank you. I think we're ready to now switch to the the next presentation or oh, like were there other items you wanted to highlight here, as we were as.

B

Jonathan wanted to briefly highlight the contributing guide to answer the question in the chat, so the most of information we present today is already available as contributing guidelines, for example, for jenkins website. That is contributing a dog name inside the repository, and here you can find all the information about uh how to contribute how to address particular use cases, for example, writing documentation.

B

This is what jonathan was referencing, but if you want to create new one, if you want to create tutorial or write a blog post, you can also find the information here and same for development needs.

B

What will present how to do it. But if you want to have more information, you can also find them on this page.

A

I find it particularly nice that I can actually read the source code for those a doc files. If I've got a question about how to do something, I can use them as a pattern to do something else. So excellent. I think we're ready next for vlad.

C

uh Yes, thank you very much mark for letting me talk. Let me share my screen. First and.

C

See if I can do this, um let me know if you can see my screen.

A

We can thanks very much. Okay.

C

Well, uh let me show uh well, this is a visual code. This is id one of the popular ids which uh people are using, but nothing that I will show will depend on this ide. So nothing is uh depends on this specific uh development environment and if you have just terminal, if you have just windows command screen like you feel free to use this, it is just convenience to have in one uh developed environment, editor and terminal thing.

C

So for my own benefits, I prepared this uh file, which is in markdown uh syntax, and uh it is just convenient for me not to forget everything that I would like to talk to you about, and it is possible to view this in uh like like in the web. uh Well, the first thing that you want to do when started contributing, of course, and that are talking about just contributing to uh documentation.

C

You go to our documentation website, which is jenkins.org jenkins, infra organization, and you look for issues uh and well. I specifically for this um demonstration uh picked up one of the issues which created myself and it is fixed terminology, uh one of the uh projects which are oleg highlighted in his uh presentation, but it regarding only documentation part. So you click on this issue and it describes exactly what needs to be done. uh It needs to change white list uh to allow list.

C

This is new terminology that we are using in a developer section of documentation uh and it presents all files that needs to be changed. Links to all these previous presentations. You can go through this and uh browse them as well, and it mentions very important feature thing. It is accepted that documentation changed may proceed the user interface or code changes, so you can change documentation without worrying that the code is not changed yet because as well. uh Some people may know that code little bit more difficult uh to change that documentation.

C

Sometimes uh so, uh let's uh watch in case, if you hadn't done this before, let me bit shift my screen. uh First thing: is: you need to fork, of course, uh if you haven't done this before for this repository too, I had four this before uh so and after that, after you've worked this, you just need to clone this documentation to your own repository. This is the copy button you just copy this and you can use different well methods protocol right now.

C

It is available uh using github cli, which we have recently introduced, but just ssh is also possible to use and you copy this uh uh well copy this string, and after that you just let me see you just use git clone and after that, um just cut and paste this copy copy, uh sshd command, and I had done this before so I am just not doing this and after that ucd to jenkins dot io, and this is uh the quantitation website uh and if exactly well, I'm doing exactly what is written in this 3d file, which in case if people want.

C

I can share this, but this started specific to this uh after fixing this issue regarding terminology, now what is important- and this is usually uh what I'm doing when I'm looking at this, I would like to be in sync with the master branch, my own repository, and this branch is even with jenkins, infra master in case. If it is not well, there are two simple commands which I organized in like git sync,.

C

Shell script, which allow you to make sync up with the master repository very, very easy, and after that, what um you want to do is just let me see in which branch I am okay, when the master branch and so what we can do, we can do kit check out uh minus, b ah and well x del, and you can like put any name for your new branch and just try to match what you are going to do.

C

So people will understand easier to understand for those who review your uh contribution basically, and your kicks uh and uh minus b means that you are just creating right now and it will copy in case. If you have, you just do check out, so we are switched already to this new branch and uh we're already there. Now we uh go replace whitelist with allow list for every file in the selected set of files and, of course well.

C

I opened all these files in my editor, and here they are and again just to make sure that you understand we are taking all these files from um from this list, because this is very detailed, written actually uh issue. Sometimes it is not so detailed. Sometimes it is like uh uh yeah, uh but it depends uh so uh you know we're going to this specific files.

C

Let's start from this like class last issue, so we just do search for white list and we'll try to replace it with allow list allow list, and you see there is only one thing which we need to do. We just click enter, it is replaced and.

C

Another thing allow list.

C

uh It is modified here, we'll go to another file and just do the same. It is our two on occurrences of this just replace them both both and for this one, the police- and it is modified, go to this one and so on. Basically, we can um well just see how many here are our list, and you see this is everything in not in the code. It is in the communication which can easily be replaced and well, there is no problem in doing this, so we will replace this one and let's go to this action.

C

How many just one occurrence? Oh here we go, we replaced it whitely still now we still we're modifying basically the quantitation. Now there are like several more files. Let's go here, and here we have this well plug-in white list and.

C

I'm not sure that we are able to replace this because we'll break some links. Let's go to this one.

C

We have here, 85 occurrences. Well, let's just see what we have a white list and there is link. We can open this link and see what is all about.

C

Just a moment, let me.

C

C

It doesn't bring us anything: oh okay, but oh, let's go next and see what we have here.

C

Well, it looks like most of this is related to the code.

C

Most of this is related to the code and well uh you can see that it is like the name of the uh file java file here and well. uh If we can start like modifying this right now, uh it is little bit more complex. uh Well, I would suggest, since we are talking about documentation- let's just don't touch the code at this point and stay with documentation.

C

Let's go back to this uh uh to our ide and uh we'll make sure that we already change these files and what we can do right now, we're still in this branch we're going to uh well execute this, make wrong command and I'm going to switch back to um back to my review file uh here. It is and we're going to make run- uh and this is micron in this make file, and this is how you uh run your um well built uh your local site id.

C

So it will create uh build the entire site and will start a docker container instantiate docker container, and it will start it on localhost 4242 and you can like, if needed, change the sport, but I would not recommend for new contributors to doing this and go inside, because this was written. Make file but really smart people, and so they knew what they were doing so you just can use uh as it is. So it is executing this pipeline initial uh jenkins file in this repository, and it will start this.

C

Let's try to open this and see if we'll be able to not yet um so. Let's go to this, it will take some time executing pipeline. So it's still trying to do all these things, and here we are so it's like started this. Let's try to uh go back and reload.

C

And we can see that we have. uh We have this uh actual uh our own site localhost and we have it here, and so we can. um For instance, let's see now we change this plugin site doc and I guess plug inside dock. It is in developer, guide and.

C

Tutorial tutorial, it is somewhere else. Probably now, let's go back, let's go back, let's go back and it is reference the quotation maybe plug inside here and let's look for what list we didn't find it. What about? Allow list allow list here we go. So this is what we changed and uh we can again just click on this and see that it works, and here you have this uh uh well, it goes to another site, a brace center too and see you can see a white list here and well.

C

It gives you some clue of what can be done next. So when you start doing some changes and you are start doing some requests, you will get understanding well. This is how I can just continue contributing and it is very easy. So uh well it's uh what's interesting about this- that it is uh uh well uh with this site. uh uh It's a very kind of interpretive mode.

C

So in case, if you will change anything here, uh it will modify the site as well, and so you will just, uh for instance, if you go to id, and you want to change look like inside, uh and you want to change. For instance, here put something like jenkins: save it go to this site, refresh it and you will see jenkins plug inside, and so it is very easy. You will see what uh kind of uh what it changes, what you will get basically and you don't need to restart, which is very, very variable.

C

Let's uh like go back and remove this save it again. So we'll restore this uh okay. So now uh you already changed the verifiedly, just simple, uh sending the test and all files uh well, that your changes work, and so you can just easily after that, uh go back to your id. Let's uh stop this! Okay! Let's stop this for now uh we're stopping this jogger um container, which was executed right now and let's go to so we'll not forget 3d file, and we can just start contributing to this.

C

So we will do is get starters, it will show what are we edit? So we can just hit add content and again, do you get starters, for instance, so all our four files have been added and we can just do git commit minus am and we can. uh Oh, I put fixed terms ah yeah, so we fixed terms in dev, section.

C

Something like this and we'll do this, and after that, we'll do git push. uh Oh, I already always forget how you need to do this correctly. It will just remind us and you're trying to push it to your uh to your own repository now. After that, you can open this. It will show you what to open.

C

And you can uh hear just it's possible to mention that value some files we hadn't.

C

Touched some files since will require modification of code.

C

Because of our code, notification is a little bit different and we can break a lot of uh links, and so let's not do this right now so just you mentioned this, create pull request and after that, uh well, you will see how, like everything, is automated process kind of except reviewing.

C

Of course, uh uh you will just basically wait and uh see uh what is the problem like how the checks given or what's interesting, that some checks haven't completed yet, but there is process already going on and your testing start and uh well, you know, jennifer's project is using uh blue ocean plugin and just you can go inside and see how everything is uh well given the process. So, basically, after that, you sit and wait until uh you will receive approval and probably most likely, you will receive it in email uh and uh well.

C

I just go inside details what you need to do to fix one specification. I haven't shared that readme file, but I will be glad to do this in case if needed, so you well, you know how easy it is to do how easy it is come like to contribute to the jenkins project in the communication area. Like showed in different other areas, mark will show how to do transformation from wiki page. So you are welcome. uh Please start contributing and well. You will have a lot of fun doing this.

C

On this optimistic note, I would like to end my presentation. Thank you. Thank you. Vlad.

B

Thanks very much yeah. There is a question in the chat, so one more prepares, so the readme file you shared is a very helpful stabilistic guide. Is it available for everyone or is it something you use just for the presentation.

C

Do you want me to answer yeah yeah? Well, I prepared it just for my presentation, but I would build that to share this and um just we can discuss where to put it, and I will be glad, of course, to share this. No just yeah, it's not private. It will not be private.

B

Thank you. There is another question which is rather related to drinking score, so from naveen I'm getting that junk score is quite stable, so the most of what happens in the plugins.

B

So there are two answers. Firstly, indeed, the most of work happens in the plugins, but it's not just because the junk is called stable, but it's because of that the most of the junkies functionalities in the projects jenkins, has a framework system and yeah it's. The agency's culture is related to small implementation, which implements core foundation and apis projections, but all the business logic all features the most of wembley interfaces, etc. They happen in the plugins.

B

So that's why it's a good area to contribute, especially since any plugin is basically a semi-independent project with a smaller codebase, so that you can actually ramp up and explore them.

A

Yeah I I like I like that observation. As one of the one of the genius elements of of the jenkins project is, it's got lots of small projects where individuals can contribute very effectively with without worrying about disrupting larger organizations or big monstrous things so whole-hearted agreement. Plug-Ins are a wonderful way for you to contribute and help.

B

Yeah we have some plugins, which have a size quite comparable to the size of the junkies car. Okay, jenkins, core itself is not quite stable in terms of well, it's quite stable operation, wise, but code wise. It keeps evolving whether new api is integrated.

B

There is a lot of ongoing work, for example, for user experience, improvements and the junkies core and its apis. So inside uh this component, the results have a lot of work happening at the moment, also all kinds of performance, optimizations, etc. So if you want to explore genki score, it's also possible, though yeah this. The code based on junkies core is just it's much. Bigger and jenkins has 15 years of history, which includes binary compatibility, etc. So the code is not straightforward in many cases, just because we have to retain binary compatibility for the plugins.

B

But if you want challenging tasks, you can definitely take a look at the jenkins core. Also, there are many areas which are quite isolated, which you could try.

A

Now I, like the question from naveen navin sundar about any plugins recommended for a new java developer, and, and so I have a shameless self-promotion technique, contribute tests most of the plugins would benefit from more tests and if you, as a new developer, would like to learn something about the development experience writing a test inside of an existing plugin is often a very good way to explore. Oh, how does this work and why does it work that way?

A

I spend time in the debugger watching my test, watching I assert correctly, and that teaches me more about the code embarrassingly than most other activities that that time, developing tests is quite helpful. So for a new, a new java developer help us write tests.

B

All right there are many newcomer friendly issues submitted. Also there is a lot of refactorings available because yeah jenkins, we literally use java 8 now but yeah. A lot of the code was created before so. There are improvements you could make there or maybe contribute to static analysis of cleanups, but yeah writing new features. Also, there is a lot of opportunities check out the existing tickets.

B

There is a lot of small things you could.

A

Now we've got we've got a question. Where are issues that I can work on, and I think this might be a good excuse to highlight the newcomer friendly issues table in the jenkins in the jenkins page. Would you be okay if I shared briefly all like yeah you're doing the presentation next anyway? Oh good? Okay, so let me let me do that. I think I think I may skip that presentation that I was thinking of, but I just like to show this as a way to highlight what what they can see just a minute.

A

Let me get the right thing so that I can bring it on screen.

A

And this is at least for me. It was a good insight of oh look. What you can do yeah here. It comes so sharing screen now and you should all see a web page.

A

So this is a page that shows the newcomer friendly issues in the jenkins jira bug, tracker and you'll see here there are 63 bugs listed for the jenkins core that are newcomer friendly. There are 14 listed for the git plug-in 27 for warnings ng now. Those two plug-ins that I just mentioned have very high usage in the git environment in the jenkins environment, and so, if you contribute a fix there, you're contributing significantly to help the project.

A

So this friendly issues table is, is a nice easy way and I'll paste the link to this into the into the chat window.

A

Now the next question was: is anyone available to guide a new dev and the answer there is: we've got the chat channels that will happily help uh new developers. We've got the jenkins dev mailing list as well. uh Both are willing and ready to assist now holding center links to the chat.

A

A

Now I'm hesitant to go beyond the hour that we had originally allocated oleg. Do you think it's okay for me to spend time doing a plug-in migration, or should we call this a pause, stop the recording and switch to q a oh. I thought.

B

It's one hour.

A

B

Let's go ahead, at least this is what is in jenkins calendar.

A

Perfect, then, then, I'm going to go ahead and show show how I do do a plug-in migration.

A

So one of the challenges we have is that our jenkins documentation had spent the longest time in the jenkins wiki and that's a great place to edit, except that we had some spam challenges so about a year ago we started a project to transition from hosting the documentation on the wiki to hosting it in github.

A

This page that you see here highlights our progress and I'm I'm very pleased to show that we've we've completed over 500 plug-in migrations in the last year, plus that's really great, but we've still got over a thousand left to do so. There's lots of work to do to get the plug-in documentation migrated into github, so that maintainers can maintain it more easily, so that you can. We can update it so that we can deliver it with new releases.

A

So how do we do that? Well, first challenge is: let's find a plug-in that hasn't been migrated yet you'll, see here on the status column and if I just I'm, I'm kind of lazy I'll, just page down and find a row that has there's one that I thought I'd like to try this one. So here is the x-unit plug-in. It's used. It's installed in over 19 000 installations, I'd like to migrate that so I open up the jenkins wiki exporter, jenkinswikiexporter.jenkins.io and paste into it.

A

The url to that plugin. Now that plugins wiki documentation looks like this. It's actually quite good. It's got pictures in it. It's got a good good content list, different insights, multiple levels of of content, it's a very good piece of documentation on the wiki, but it can't be edited because the wiki is now read only so this export process. When I click that convert button, it will generate, it will read. The wiki page generate a zip file from the wiki page. That includes the pictures as well.

A

Now I didn't want to wait for this for purposes of our demonstration, so, oh and there it is so when I open the zip file you're going to see it's got the readme and it's got the docs images that are my pictures so there it is helping me along the way. Now. What I did then was. I copied that up to my development location and let's make the text here bigger there, we go.

A

So this is the x unit, plugin that I had forked and I'm on the master branch right now. So I want to check out my new branch migrate docs to github.

A

And as it turns out, I placed the zip file in my home directory there and I'm just going to unzip it in this. So what that did is unpack the things that the converter did for me and place them right here.

A

I've got docs images, I've got the readme file and if we look at the readme file, we'll see that it is markdown now, there's there's lots to improve there. But you know what, in this particular case, I can just say: git. Add everything.

A

And now, if I get committed.

A

I have something already that I can push to github and go look to see. How does this look when I present it on github so documentation to github and probably help if I say from wiki to github.

A

So that easy and.

D

I'm going to push that.

A

A

So this push and now it's ready for me to go to that branch and I'm not actually ready to submit a poll request yet. But I would like to see how it looks so, let's go look and see how it looks.

A

So we're going to ignore that and just jump right to my fork of this plugin.

A

Where we'll find my branch migrate docs to github and if we look at the readme file now you'll see here is the translated documentation that a readme didn't exist for this repository previously and now here's this readme that has hyperlinks in it. It's got the pictures, it's got content and it all looks actually pretty good. Okay. I me personally I'd want to get rid of some of the empty space here.

A

I'd likely make a make an initial heading, so there are lots of things that I might do to further improve this, but this is already a pretty good first effort and that pretty good first effort has transformed the documentation from read only on a wiki page to being able to read, write inside the github repository that the maintainers will be able to care for so we've we've made maintainability maintainability improvement. If we submit this pull request, just as it is.

A

So it's it's that simple and I'm going to go ahead and risk annoying. The authors of this plugin I'm going to start the pull request, I'm going to actually make it as a as a a a draft pull request, so they know that I'm still working on it, because I think there are some things I want to improve.

A

And so I need to mark this as a draft I'll create the pull request and, let's see oleg help me remind me. Where do I mark this as a draft? There is a technique there.

B

Do you really need it if you want to get the reviews, because draft marks, the pull request is not ready for review and.

A

At this point, I'm actually not ready to have them review it, because I'd like to make a few corrections before they.

B

Then yeah on the right side, uh there is uh reviewers on the top still in progress. Oh.

A

There it is convert to draft. Thank you yes, so thank you very much. It's convert to draft and I'm going to temporarily convert it to a draft so that I have the time to work on this before the reviewers get involved.

A

But that that's the the basic concept and this way you've seen how to do those kind of simple transformations. So I started from what needs to be done this page than this. What's available as work, I exported the existing content.

A

I did a little bit of terminal work here to to package that and submit it as a pull request and then back and I'm ready to ready to work on the pull request. Further, improve it, make it better, get it ready so that the the reviewers will have access to something that I'm ready for them to review.

A

That covered the part that I wanted to talk to, and I think I can stop sharing now. We've got a question in the q. A about hey. Can I start working on document migration. Absolutely documentation. Migration is a is a topic that we need. We've got lots of issues in our in our jenkins.io site in github issues that are specifically documentation, migration tasks.

A

Now what we found is that the wiki as it's evolved over the 15 years or the 10 years it's been maintained, is not always current, so it's not as not always a simple trivial conversion from one format to another. It requires thought and consideration, evaluation and improvement as you're doing a migration of content from the wiki to jenkins demaio.

A

Oh, like oleg smiles, I like that, that's good there. There are some stories behind those kinds of transitions that there are times they get complicated or where we need to have longer conversations about those details.

B

But in many cases it's quite straightforward and it's generally beneficial for the project. It's not just moving from one source to another, for plugin documentation, etc. Removing the documentation github allows us to follow the documentation. This code approach when features changes, get documented, along with changes themselves which helps us to maintain uh actual and version documentation.

B

Plus we can also automate the release flows and now, if you go to documentation of existing plugins, you can see that the documentation of these also referenced in the change logs so that they become more traceable for users and yeah. Of course, it's also good from the recognition perspective, but yeah yeah main purpose said that you know it's a really collaborative format. With a support for reviews. We support for versioning.

A

It really helps everyone in the project. Documentationist code really has been a very a very nice positive. The things that I've interacted with I found that the documentation is significantly better now for plug-ins that have made that transition from wiki-based documentation into github. They are more likely to update it more likely to care for it and maintain it and be willing to accept and consider pull requests that correct mistakes in it.

A

And that that covers all the topic that I had, I think we've got a few concluding concluding slides if there are more questions, we're happy to have questions.

B

So if there is no question once again, we will stop recording soon and after the recording we will grant everyone who stays online voice permissions. So, but you can ask more questions: okay, great! I'm.

A

Going to go ahead.

B

And stop the recording.

A

B

A

I was just looking.

B

A

Closing slates.

B

You were referring to.

A

B

A

That that's that's the one, absolutely okay, this one too yeah.

B

So if you have any questions, please contact us in this guitar channel genki, says oktoberfest. We will be happy to answer questions, providing you guidance, how to resolve issues debug, something if needed and yeah thanks a lot for your interest in contributing to the jenkins project, and we are looking forward to meet you in the community channels, so have fun.

A

Thanks all right, thanks vlad and thanks to jonathan.