Jenkins Documentation Office Hours, 22 Nov 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 2019 11 22 Developer Meetup Docs, Plugins, and Release Drafter

Description

Jenkins Developer Meetup discussing recent improvements to the documentation process for plugins and for the jenkins.io documentation site. Improvements include a Wiki exporter tool to assist with migration, GitHub as a documentation source, and release drafter to simplify the creation of accurate, useful, and reliable release notes.

Presented by Oleg Nenashev, Gavin Mogan, and Mark Waite

A

Recording is starting now so welcome everyone. This is a developer meet up for the Jenkins project, specifically focused on documentation and we're gonna start off with Oleg's gonna begin. The presentation give us an overview, introduction, etc. Gavin and I will be involved, will show and tell some various things, demos. This is intentionally interactive. If you have a question, you are welcome to use the raise your hand, icon you're, also welcome to just unmute yourself and ask the question: we don't mind.

A

This really should be intentionally an interactive where we talk to each other now, in order to verbally ask a question: you will have to unmute yourself and we're.

B

Gonna have so many people on the call so yeah, let's just keep it relaxed, I reduce my screen. We do thanks. Okay, so I'll start the presentation. So by the way, I shared this presentation in basics get off shot and somebody could also deposit in their resume chat. If needed, ding I guess it should be fine. Now it looks great, absolutely okay, yeah. So thanks to everyone for joining our meetup. So again we talked about documentation, poaching his plugins, specifically about gel documentation like user dogs, landing pages and also about change logs.

B

So that's our agenda. Follow me tab. If you visit jinx online without first time we have a page on Jenkins online without which you can join and follow our organs. We try to organize when small as regularly and hopefully we'll have more events. Soon. We have one event interview for December about Jenks configuration as other presentations about pipeline. So just please follow and John, and we start the series of developer focused meetups. So historically, our meetups were other forging his users, but we also wanted to have meet ups for developers.

B

So the idea is basically everything about planning maintenance, some products, development to tasting and share the guy system whatever so what we usually do at specialist group meetings. So if somebody wants to present, please do so. We are looking for speakers and BIA. The idea of these meetups is to have just monologues and discussions between developers, which I still record it, and hopefully there is more discussions, show and held sessions, then slides.

B

Obviously, if you're going to invite me, you will still get so wise, but yep there are main idea is to have discussions yep, as Mark said today we have three speakers, but if you want to present something about your experience is don't hesitate to do so, so we can adjust our discussion as we go so like at sea peaks and the algal starts from a quick introduction. Then Martin gave and we'll do demos, and then we go change, locks. Okay, that's it so questions we already discussed so just move on.

B

If the zoom chart or get earth or raisin.

B

Focus of a singer, this page yeah mark waiting is maintained, it'll get plug-in and it's much appreciated and if you use changes you may have seen this page and basically is how James plug-in pages. You look mahvelous, so we have more than 1500 plugins the most of them used to have documentation on weekend they some additional markers, etc attached. But they, if you go to be speech, you see something like that. So obviously there are some things to be improved, but yeah follow to my wiki used to be as a main source of plug-in documentation.

B

Now we also have her plugins to Jenkins Iowa, which was introduced as a part of champions to do zero effort. So now you can find plugins here. Just for example, you can get listing, you can go to whatever random plug-in and if everything goes fine you with the pitch with documentation here but I mean all this documentation is sourced from meteor.

B

So basically nothing changes specifically for this plugin, so yeah. This is how Jing is playing in documentation used to work. We had a lot of historical issues with it. For example, wiki is just hard to edit and Huff towards something before 270. We also had capture and I would say this capture was just terrible because I was able to pass it, maybe in 20 percent times, or something like that. Now it's gone, but yes still. That is a lot of things going on when you said this weekend, so.

A

Like I am pleased to note that I finally submitted the request to delete the squatted git client plug-in page, that I had repeatedly tried to delete and that spammers had repeatedly brought back from the dead. So long I was a living living with a dream. On that experience.

B

Okay, so yeah generally speaking, Jenkins wiki is basically based on countries, as you might have seen. This confluence yourself hosted by Jenkins, so you run it as a service. We maintain it in the Jing infrastructure team thanks a lot for all your behavior mean and other contributors who helped to maintain it so yeah. You can see this unstable ball on the hill, but basically it stands not just on its own, but thanks to the Jing is infrastructure team which holds is from all sides preventing it from falling.

B

But yes, historically, we had a lot of vicious alien strain this weekend. One of the issues is just a little interesting capacity, so we don't have so many contributors, an infrastructure team. This is something we're working on and the communication specialist group, as well by infra, been contributing by ions when you improve in documentation so, but eventually we can have more contributors. We also work on user experience.

B

Sorry, okay, let's go back to Mika. Actually I am supposed to run all about it, so we identity user experiences capture about all other things, so yeh it's hard to really break it. It also causes in between information, because you cannot have wiki. You can have meet hopper in me for visits it's hard to find where to find the actual documentation. Sometimes actual documentation is just missing and of course we have had some outages and some performance issues. There are some my implementation details, but yeah our wiki is really self hosted.

B

So it's not in the confluence cloud, a pleasant route and yep, sometimes it's just slow and what it means. If you are playing in maintainer that you released plug in your goal and the one of the changelog and the wikis down, so you send a message to infrastructure in chat, hey I have a problem, then you wait and probably you forget, to change, load and kill somebody. It reminds you make the translator, so obviously it doesn't help.

B

Then there are issues with security upgrades because I can't use any other service also has some release cycles, and it is that, if you want to protect the jenkees users, for example, from the personal data being exposed or from just people going and hugging the stuff- and we need to regularly update the game, puts additional pressure on the jinx sake and lot, but in these disks farm attacks, so they think mark mentioned so historic new Jenkins week it was a destination for attackers because hey if you have accounting changes lob you can go and edit any page without additional technicians without additional reviews.

B

There are some protected pages, but yeah. The most of pages are definitely not protected and if you're like buying water heaters in Jakarta, or something like that, probably you would be interested in this bomb attacks. But for the most of users is a major disruption and again people spend a lot of time just for cleaning up. We cleared everything, changes, bunny, users and yeah. That's why we had capture I apparently didn't help so yep, it's quite complicated. In at oh boy.

B

We actually had just another cottage and just not as formal talk so maybe mark has more content of what exactly was imparted, but we had a lot of pages. I just missed the pocket, but what you might have seen there was a tweet from Tyler about jenkees. We keep going to the read-only State the results, a developer, mailinglist announcement. So if you follow their James, develop admin increased and we definitely recommend you to do so. You can see that there is some commands, so there is a lot of discussions.

B

So basically this was a trigger for the today's meeting and for all the birthday present. So stay tuned for that and here, if you go to Jing this weekend, so I have a page open and you can see that the rooster head over there that Eric is still in the maintenance mode. So basically the most of Jamie's contributors cannot edit wiki pages. Now we've got permissions for number of users so that we can help meet invasion, but that's it for the rest, you should wiki directs you to the blog post.

B

So this is a blog post. We sent out a year on October 21, so it's just four days since this announcement. So in four days we basically updated all our guidelines and Suburban. We also created the first version of exported tool and we were able to offer a short version of this plug-in migration flow, which we are presented today. So yeah, thanks about for everyone to everyone and yeah I. Think that's it for that. Any questions so far.

A

So-So one question I'm, assuming that that the wiki is likely to remain read-only indefinitely. Is that also your assumption Oleg, or will there be some day in the future when it comes back and.

B

So originally, when I've seen this announcement, a my understanding was that we are going to revert it back to the editable state, but taken the success with migration tools with migration guidelines.

B

Now I made my peace with the current situation, so I'm happy to accept the state that vicki has faced read-only but yeah. If somebody has concerns about it, that is developer mailing list so just comment there and we can start from it.

B

So paint doesn't Lee yeah I, don't think that it will be diverted unless there is a strong need to do so great.

B

Tokine any other questions.

B

Okay, then, let's continue so yeah, it's redundant state, so what it means for users and for maintain years so first, they all use a developer. Documentation, which is the only key, is not editable voguing maintained, as you can all also cannot edit your documentation unless you create somewhere. You cannot edit challenge logs because in most of plugins change looks still posted on weekend and also you cannot update labels and labels really used historically for marking the plugins for adoption or putting plug-in categories right now.

B

There are alternatives for that, but you cannot longer use any cases. So our default suggestion is migration and you have basically two destinations. One destination is about plug-in repositories on github. So if you maintain a plug-in, you can just move for the documentation to your repository, and if you just all speak about gene generic dogs, you can move to Jenny say oh, so these are two main ways and both ways: maaan yeah. Both ways basically allow you to achieve the commendations code.

B

So the communications code is just concept which says that okay, let's thought our documentation along is all other product, including code, including do flows. So now we are used to store jenkees files and ACM. We also may be, in definition, same ECM, and the question is why don't we put out documentation there so I'll just show you an example.

B

Why I don't? Okay? Now it exists, I'm, not sure, probably Ayesha's, on my laptop, so try something okay, so yeah. This is how Jenkins code repository so I just take it. For example, okay, you go to read me and here you can get written in D.

B

So basically, this is a file which is starter right and inside the CM and which is displayed in neat, huh and it was one of the reasons of speed brains because many plugins, you already had three means to appear Twitter on github and we kissed or pirouette on jinx plugin website. So it was a quite difficult to find actual versions. So what are good things about it? You could put everything today. You can also you can have additional pages with documentation. I don't have them in this repository, but you can just go to configuration.

B

Is code, for example, funny configuration is called plug-in so here you can see that, in addition to the main landing page, you can also have the dogs start the right-hand side, so here, for example, otherwise, documentation developer documentation, contributing guidelines which had a part of github metadata, some historical documentation about plugins, etc, and there also there is also a teacher, a documentation, and you can see that this documentation is emboss markdown and as a dog so dependent on.

B

What's your preference, you can use different format and the hands you can put the entire documentation by a two-bit hub or what it needs you. So.

B

Firstly, it Hubb can become a kind of front page for you because it hub involves its own ecosystem and it means that if your jig is developing- and you will likely start from github to visit us know from whatever plug inside so by putting documentation there, you can help your users and potential contributors to know more about the plug-in and to see how to contribute etc, as at the same time, it's easy to contribute for others. I'll show it later, but basically you can edit this page right inside the web interface.

B

You can use markdown or ASCII dog and github for offers a lot of features, so you can just click a menu button get there. You can get preview in the web interface and everything would work. Also, you can change your policies and this is where documentation is quoted. Earlier comes from free because you can say that, ok, if you contribute, for example, a pull request, you are expected to write the commentation as a part of the pull request. So it's not like something.

B

Ok is something somebody creates a fish, and then you ask that please update a week. It might happen no or not you as a plug-in main here and said expectation that any feature has to be decremented and it helps its users. So that's the main idea and you can edit it. You can review that so everything else.

B

At the same time, it also gives you a Virginian, because when you release the plug-in you'll get up top and type in a bit hot, so we also get additional documentation which you released, and you can point your people to version. Do they use different tools? Again, it's not possible in Jenny this week to say: yeah. There is a history, but it's hard to find what exactly the documentation for your version and the people can just edited on the flight. Now. Last but not least, it's also about contributor recognition.

B

There is a story we shall be presenting about change lots, but basically contributors to documentation just become general contributors of your visitor. So you can mention them. They change loads. If I mention documentation and change loads. You can highlight these contributions and the finally me giving people to contribute more to your repositories. So that's the main idea for it.

B

Okay, now, let's take a look at the Jenkins our website, so jinx, a your website is one of projects. Basically this our Glendon. So it's hard to assume that nobody's seen this on the call, but it just in key. So that was Jenkins IO, which is the community which our portal, which is our portal and the entire portal, including all the documentation, including all the listings, sub projects, etc. It's indigenous code. So you can fool you the producer, decide in the development environment. You can hock it and risk.

B

They can show you a development version which is just running from my machine just in case. So it's a local machine I can edit it week the end I check changes. So if you go to the repository, you can find that this side here so they're also contributing guidelines, but basically what you can do you can just edit everything from the web interface as I said. So, for example, let's say we want to contribute something yeah.

B

So here you can just pick edit button and I can, let's say, put a load here or something like that.

B

Then I can preview changes and you can see that there is whole wall edit. So all these pages on Jake say: oh, you can edit in this way, and you didn't need to put anything additional and after you do that you can just commit your change or submit a pull request.

B

I want to be doing so because I you to the repository because I have I would be submitted to the main one, but yeah that's the idea, so you can quickly create the patches and, moreover, if we talked about any documentation, for example about pipeline plugins or something like that, I find documentation is hosted on Jake. So at the moment you can just go and as a user, if you do not know where the pitch is located, it's also not a program because he here it's development thing, so it takes a while.

B

But here, if you just do not like this page, you can click improve this page button and well I just open side in a web interface and as I present it. You can just edit that this page of both changes and submitted. So that's how it works in this environment and the Jenkins I/o is fully contribute about. If you want to suggest any changes, you can do it from the repository and we have a decent documentation for different cases, so there is contributing asciidoc in the lending.

B

You can see that there is a lot of topics like input and prayer where it's for common pieces. If you want to change user to the community agent form to write a blog post, you can just follow these guidelines and again this is the first way to do with an engagement ring in Jenkins the most of things. Linux talk there as I said: okay, I guess I passed through this page, and you know what I wanted to say that this website is all was also introduced as a part of Jenkins to do zebra.

B

So a lot of documentation has been already moved, but not all over this documentation, and we will have some examples later today about how to move. Okay. Let's talk about plugins I've, already shown your how plugins portal looks like so. Basically, it's additional portal, which is available from the Jenkins web interface and from the Jenkins website, so it's basically a plugins where you can navigate the plugin documentation, and this is a second major part of in documentation.

B

We offer because this website is referenced from JB's update, centers, so plug-in users who do the updates, so they usually went there to discover the changes.

B

This website takes data from jenkees wiki and from our beat sides, so you can see that for plug-in pages, let's just take a random one under sure. What is this plug-in? Basically just released with no documentation, so I? Guess: let's try something else: okay, so where are this another plugin? And here this plug-in already uses github as a source, but you can see that there is some installation statistics, information, but dependencies links to java dog to get help and lots a lot of documentation which is being sourced.

B

So this common experience for plugin users- and this is what we were editing and one of the issues for us- was how to mean greater to the documentation. In september, 2009 we've got support of the tapas wagon source, so this is was representing and let's see how to migrate.

B

The distortedly is not new for Jenkins, because we knew that documentation is code is good long ago and the in 2016 at the energy soft project for me gradient the documentation. This project didn't succeed due to some reasons, but you didn't forget about this idea, and there were some discussions later some prototypes. There are people who started moving lignin tation manually, but we started getting traction some at 19, so one of James contributors is being. He proposed the pull request, which said that github with mutation support, so basically he took over the list of ID's.

B

We've had Fuji so and start implementing them, I'm, not sure whether his because on the call today but yeah, just you shout out to him thanks a lot. It helped us to move the story forward and yeah after some delays. We finally started working on the plug-in site updates in the background. So if you think that we just implemented everything for this after week, it was good to they don't list it. It's not actually. This body was already you know.

B

At least we started sub-project imaging because the communication special interest group and in September we immersed the public quest, which added support for github with mutation sources now playing inside and after with this, was improved. So by the time in October, when a weekly, when done, we were confident effect. Actually we can use this, for we already had some drug to balance for the community immigration, so we were able to build the solution on the top of it key.

B

So what's going on is the plug-in mutation. One stories is supported hub information as a source of documentation so yeah. Now we support ring me pages and we obviously make pages the right hand side bit hub, but there is also other things we want to support when changelogs plugin labels making information. So there is an epic in jenkins data about that. This epic is here and we keep iterating on that. You can see that there is a lot of green cakes, but there is still some stuff to do there. Then there is another.

B

It initially started for mutational, plugin and Gingka documentation. So I guess it's a single epic, but not so many tasks for there, because you need basically need to create tasks so yeah. There is a mission template for anyone who want to beta-test open immigration but yeah. This is a community without documentation, special and let's go to keep this mutation and we still have a lot of things.

A

Like there's no requirement that I have to create a ticket in there, I can I can certainly migrate a plug-in to use the new the new system without ticket right I. Just just do the migration yeah.

B

There is no requirement, so it's just for whatever what matters, because somebody may want to create a ticket for the cloak or somebody just wants to pay. They knew differently tickets, for example, for Oktoberfest like we did before, and actually a lot of opinion pages women gradient you to Oktoberfest, so we then you can use it, but you wait a few not required to pay tickets. Okay and finally, there is this blog post, which fully describes how to migrate the things and how to enable the stuff.

B

So it's what and given will be represented in just a few minutes.

C

B

C

They're so so labels- it's not working yet, but in labels.

B

So yeah when I speak about labels, so there's, for example, if we go, let's see I have configuration as code plug-in open. So he, if you go to the root you can see that there are labels, a computation or school. Jenk is October for the Jencks, the degradation or something like that. These labels, who made useful for Jenkins, because, for example, if we go to the Maynard plug-in or to whatever you, can see that there are some labels, and here you can see that plug-in, has no labels.

B

Because again we duplicate the support of weekend and we didn't put labels Titans site metadata. We have a repository update, Center tool, so it's basically changes that mean station or update Center yeah.

C

After I turn to that I'm mostly worried about, but.

D

C

Scm tag will disappear when I migrated yeah.

B

Right so here we have some. So so it's it's wrong file. So then yeah label definition said this okay. Here we go so currently. Labels have been so strongly from this file. Daniel Beck has performed abysmal nation. Maybe you a couple of years ago, so all information is being sourced from this page, but even though there's no metadata, for example, like familiar plugin, basically now my left plug-in has no categorization and ejects update, centers inject this installation of users, etc, etc, and it would be great to have support of github text instead of labels.

B

So now, if anybody wants to fix that, we just go to this file and propose a pull request.

E

A

So, just for clarity that bobby, that means that transitioning, your plug-in documentation from wiki to github, won't sacrifice. The labels did I understand correctly, like if they're already in this file, that you're showing on screen, they will continue there and you.

B

Feel some time.

A

When we transition the label, support yeah.

B

So, for example, get a trigger plug in one of our plugins are maintained by Bobby I believe it has a triggered label here so which will be displayed properly, but I guess that week integration is already dead I. So what we see from a left eigen, so we can double check it. When begin, we can yep. Our plugin sets to has terrible su.

B

Also we it's not really very easy to find it in Google, but you can find gimmicky easily, and here you can see that the rest old wiki page and we solve equation if it includes labels somewhere at the bottom I think I am just not I'm, not seeing it in the bottom either. So are you know labels yeah.

C

B

That's why we do not have labels, so probably we cables I still supported, maybe not anyway. I wouldn't bet on weekly label supports that remain a long time. So yeah my suggestion. If anyone wants to fix labels, just submit a pull request here and later, we will see how we can use github topics for that, because it could be more convenient for plug-in maintenance, so yeah. So, therefore, such a question on somebody, it's one of things we still have in our backlog.

B

F

B

So a current state, so we again Ricky, is and that I really state plug in the communication from github is fully supported. So we you can have read me as markdown as ASCII dork. They will be displayed. You can also specify custom locations so that us plug in maintenance and say that my weekly start my landing page. They start not on the readme indeed, but somewhere in the documentation.

B

Actually it was a pull request by Bobby and me: haven't commented it, and by now we have more than 100 begins, which already moved to github so yeah. It's a nice progress there.

B

There are some examples which I have already shown and if you want to see more examples, one of the useful source of information is this side which will isn't soon, and you can see that there are some statuses, so all the green plugins, if you go to plug inside the client, you can see that the best documentation which is retrieved from the hub now use all screenshots with all pages, with all the relative links. So if you have less than the communication, they will be still displayed so with the current state.

B

You can me great, and the blog post describes how to me linked and that guess you do have presentation by mark and Gavin, so they will describe how to do that. I already spent a lot of time, so I'll just say thanks.

B

Twelve contributors, I cannot least everyone on this slide because we had dozens of 20 readers who helped with plug in immigration and this deputation aggression, but yeah thanks a lot just being it who initiated this effort and pushed it forward thanks a lot to baviaan for the migration to for all code reviews or maybe ahead.

B

That's a lot different infrastructure because it was implied deploying services like plug inside the leaked exposure, and only we help us unload birth mark also contributed key and they about and helped opportunities and the government agency and the team helped me the recent migrations and this progress starts so yeah. There is a lot of contributors and again, that is hundreds of contributors who just helped remove the plug-in documentation.

B

So thanks a lot to that, it helped us to overcome the major infrastructure outage and probably we will be able to provide a great documentation for the users of Jenks, the exilic yeah. Thank you. So if there is no questions, we'll just place it with real demos,.

A

And I think Gavin we've got you first on the list. Doo doo. Would you like to take? Take screen sharing, let's see, oh, like I, think that means you need to surrender the share. Okay.

B

I'm happy to do so.

D

No where's, my notes. No that's.

D

Okay, oh yeah, okay, so I'm. First, it's winter, yeah.

B

That was a question from what they've all put in place for adoption, but yeah I think we can discuss it after the presentation, because it's a bit also a side question yeah.

B

D

I'm going to quickly cover the tool, so this this tool started as a I, wonder if I can do it and then it quickly became oh, my god, everyone's using it I should make it work better. So we uh it's started off, it's just a simple: you enter in a plug-in name use and you hit convert, and originally it just gave you markdown Oleg asked very quickly for asciidoc. So then we started to have the same thing where you wanted to do this.

D

You want, you add a selector, then that very quickly realized that for some plugins they have images. So we can't really do this as a single box. So then we added the markdown, zip and asciidoc sip, which I have already downloaded, which will do the same thing, but it actually includes images as a zip. So you can actually do your fully explored and then it quickly ballooned past there. So now you can do the actual plugin ID, the actual confluence, page ID.

D

You can take any confluence page or any wiki page I, don't have any wiki pages open, but you can put anything in there. So you can just grab one at random. Put it in here and it'll go find everything it needs to do and export it exactly the same way. So this very quickly became a official tool. It's a started office I, wonder if I can do this and three hours later, it was done other than that yeah.

A

We also added a progress page which so Gavin Gavin. For me, this was already miraculous, just I think you, you undersell how important it was what you did, because I was dreading the act of converting wiki markup into asciidoc, because it's mind-numbing ly boring and doesn't require any real thought, and you magically gave me something that produced output. That was very usable so that.

D

It was great thank you for doing something. I really like doing is I, don't I know how much I love the command-line and I know how much everyone else hates the command line, so I like making tools that just wrap the command line for me, so one thing I will mention is while everything else in Jenkins or a majority of other things in Jenkins a little Java. This is JavaScript, so that might deter a couple contributions, but for the most part, I think we actually hit pretty stable point. I was going to show I.

D

Think I was supposed to show just a basic conversion, so the plan was I lost. My note notes, but essentially you can do essentially any plug-in in here, so it doesn't really matter it should pull.

D

It should pull the full markdown for you, though, of course, the longer the the bigger the plug-in documentation the longer this takes, but it will run hopefully, maybe if.

A

It doesn't it you, you picked a really big one, but it certainly has run because I used to forget client plug-in I used it for the get plug-in and I know. Everyone is astonished. I used it for the platform, labeler plug-in as well, vitally crucial, important plug-in so.

D

I prepared because I figured this will break. Could demos like that, so this is just the output that the the zip gives me so I could I could do it offline later, but essentially you take the anti spammy markup formatter and it just pulled all the documentation from Jenkins or from the wiki and.

B

This thing to me, gonna.

D

B

This page, because here for me, it's fine but for those forum, small screens, maybe.

D

I have no idea how to do that so I, don't know how it's not important. Okay, I can do the other one though okay.

D

No, that's all wrong. Auntie mark up not mark down the cute.

D

Yeah I can do that.

A

One no there we go now for those those like me who have have in inadequate eyesight.

D

Thank You Thea yeah. So again this is not the best formatted, but it does function pretty well. You can enter in your any plugin like I said and then, if you go the same thing, if you go to the actual oops, that's actually a good one sure. Now we can't find a wiki.

D

And you page any page.

A

You do it well. What you're highlighting now is one of the realities of the wiki. Is it's just not as high performance as the static generated sites are it. It doesn't have really great response.

D

Yeah and Mark will be showing that a little bit later, anyways so I'm, not too worried about it. Where did my finger but yeah it do I'll put the the files in both markdown and ASCII, and you can also do the zip file if you want it offline or you want zips or attachments that kind of thing, and then last week we added a the migration doc, which again I know we'll talk about it a little bit later.

D

But again, this is just showing all the plugins all the ones that are either ok or to do. You are being pulled from update Center, so mailer specifically, is okay, so it's been migrated to the plug-in site. Credentials has not been migrated yet and then some of the ones that are PR we've manually mark them as PRS no they're in progress. This is not an automatic process. This is something we're still talking about how to do automatic, but for now any of the PR ones are all manually marked.

B

D

I think that's it for me, on the actual app I think mark was gonna show actually how to do the full process. Thanks.

A

Get it yeah thanks very much yeah.

B

While Lewis, which I wouldn't I, would like to say thanks to one dog like him, so pond dog is open-source tool which is designed for conversion of documentation. So getting did a great job to create a service and sauce for conversion, but yonder that would we use another open-source project which helped us a lot to get this thing done quickly. So yeah.

D

It was so easy with that tool. You just say: I have HTML I want martinandheike cool done, yeah.

B

Why give it to all put flux that filter out some unique Estelle's, etc, because yeah Mickey generates a terrible HTML yeah.

D

B

You needed some investment interlocks, but basically it's under condo.

C

B

C

That we asked you dock the generated. Ask you know had some artifacts left, but they weren't disturbing much yeah.

B

C

B

We have for now innovation guidelines. You will have to bring up some of the bugs and maybe I will show it quicker. My.

A

Ready it is, it is an imperfect it's an imperfect translation for sure Bobby, but thankfully it's the beginning of a translation and a dramatic improvement over the Oh copy and paste text trying to do that that slogging mind-numbing work without the help of the translator. Oh yeah,.

C

It wasn't much I needed to do to clean that up, but what most works out of the box. It's awesome great and.

D

So do the zippy actually it'll do the images as well right.

A

Yeah this this process, at least for me, has been an opportunity also to not just transform but also look at or their improvements I can make, while I'm here and it's put the documentation maintenance right in my developer workflow. So this is how you do a transition for a plugin I'm, going to submit a pull request to the credentials plug-in. So first check check was on the migrator on the wiki exporter, find one that says to do, and you see the status up here that says own.

A

We got less than 10% of the plugins converted, so there are plenty of opportunity for things to do, and some very high visibility plugins that actually already have documentation inside their github repository credentials is one like that. So as SCM API others as well, so the migration process can be actually quite simple, so the migration process starts with identified. Does this page use wiki based documentation in this case it does? And the giveaway here is this plug-in information block here which you're I'm on the plugin site? But it's telling me to see the plugin site.

A

That's your hint! This is coming from the wiki, so then, let's go to the. How does the plug-in site look? Oh okay, is there useful information here? Well with this particular plug-in?

A

This whole table is actually not terribly useful anymore, because we've long ago, gotten past version 2.1, that's 16 on the credentials plug-in with a much bigger version, number guess what the wiki is out of date, but the source code is not out of date, so here's the source code for the credentials plug-in and if we look in its Doc's directory, it's got a user guide, a consumer guide and an implementation guide. So what I think the plug-in user should get is a link to the user guide, so they need a link to this.

A

So all I need to do is capture the URL of that page and now I'm going to go back to credentials, plugins root level, open up the palm and.

F

I think the user here is a API user, not a Jenkins user. Actually.

A

Jessie, that's a good, that's a very good point, but I think specifically in this case, it really is a user. Let's, let's double check, because that's one that I think there is an API consumer guide as well. So what I see is the user, a doc which talks about yeah? Okay, maybe you're right? Maybe that is.

A

Yeah well no see, but when I read through this document, it talks about things that I think are our vital to a user and has pictures for the user. So my assumption was this is a better choice, but you got a good point Jesse. That I may need to think carefully about what I'm, what I'm showing to people but I think this thing really is user centered. It talks about system, scope and global scope and user scope now.

A

Others certainly I think there are other plugins where it's really API documentation and that's probably not the thing we want to show on the plugins site.

A

But Jesse would do you think that this is looking at what we see here. Is this a reasonable thing to present on the plug in the site.

B

Right, oh yes, oh yeah, this points to use it a great or whatever I mean the linking commute service pointers. That's.

A

True I could just do the Edit Durrett I had it and put put another page which jumps into that, and that was the that was the page here right, which said: I could jump to this one and then the then the then the the reader of the plug-in page could choose which one they want to do from there. Oh either would be either would be fine, let's go with for now. Let's go with short documentation and we'll have that discussion.

A

So we're going to take this one and let's go all the way up to the top level.

A

I just open up the pom.xml file and I could do this in a fork on a local disk, drive or I can do it here and I change notice that there is this line right here, which is the URL line in at the main level at the first level inside the palm file and I'm going to edit this file click the Edit icon. Now, if I had not already fought this repository, it would have forked for me.

A

So it's already copied into my fork and I can now go and go ahead here and see find that URL again it was October right there mm-hmm, so I'm gonna. Take that out. It's not going to point to the wiki anymore. It's gonna point to Master Doc's readme doc submit my pull request so switch from wiki Docs to github Doc's or plugins Jenkins dot, IO Oh blessed.

A

How about? Let's use shorter words using T.

B

A

Now, as a word of note here, this I'm going to propose the file change I'm, going to submit the pull request. This change will not be visible until the maintainer accepts. The pull request merges the pull request and does a release, and that's that's just the nature of it. We have to go all the way through the release process before it will be visible on plugins that Jenkins that I. Oh, so, let's create that pull request so.

B

This information has been pulled from jinkies update Center, so we need generate special metadata file, which has been consumed by plug-in side in order to present other things so yeah, that's why it takes so long.

A

So pull request ready and now, of course, this will run through the whole CI process on CI a-- jenkins that I Oh shame on me. I should have given a better name than patch one, forgive me, but it is that it is that simple now there are. There are many different ways that plugins made you do documentation. In some cases they may document the docs on the wiki may be better than the dots that are in the repository. Then your pull request should include a doc file. You may choose to use the existing readme.

A

You might choose many different ways. The same fundamental technique applies, use the best Doc's you've got put them inside the repository either and readme, or another location, update the pom file submit the pull request, release the plugin any questions. So far. Oh oh I, like that Jessie. That was awesome I. Thank you very much. In.

B

From yeah yeah, thank you, so maybe I'm not a question, but just a comment. There are two ways to specify the location of documentation. So one way is just put a link to your github repository to the root massage key is lying inside will use github API to like heat, the readme page, so github itself is able to like it, read me from different locations and to display that it's one of the ways and then we will use github REST API in order to render for this page in HTML.

B

Another way is to put a link to read me in markdown or ski dog like Mark presented. So both both of these ways are fine, and the majority of plugins now just puts documentation in the root of the repository, because it's also the page which has been presented to visitors on github.

B

It's a choice for anything linking up. So if you want to use a bit different, we just do it.

F

Oh by the way, if you just link to tree / master / docks without specifying the readme, not a dock they're, all that still get personally I.

A

Guess not and that one that one I don't know Jessie it's a good question. So the idea there was for the credentials the credentials plug-in couldn't have linked straight into the docs directory right and then let it decode which file. You know.

E

Without the finally surprised and and I don't know, that's a good question. Yeah.

B

Right so now, I support the either link to the repository or link to the file. Specifically, you cannot link to a folder right now. Okay, because the folders do not have presentation, API voila, unless I messed up something. This is the parent behavior great. So.

E

B

Go ahead, yeah another thing to keep in mind that the documentation on plug-in site will be displayed only for Vikings using Genki share organization. So, if you host plug-in immunization me you'll, not support github as a source, at least in the current implementation, because if anything goes wrong, we have no Illumina access to change their layout and whatever. So when we will discuss options because I did not enable it for other organizations, so yeah the most of the plugins are within jzi, and this our prefer you of course, and nowadays thank.

A

You now like, we definitely wanted to cover release. Drafter we've got about seven or eight minutes left, and I would prefer we go into release drafter because already just showing this piece, I was reminded oh where's, the change log for these things and I really love release. Drafter. Did you want to get into release drafter for this session, or do we want to do that at another time? We.

B

Couldn't put our footage for 90 minutes well,.

A

Do all we got time? Oh my mistake: okay, even better yeah, I'm.

B

Just really chicken, because I was so sure that I scheduled it for 90 minutes. Oh then,.

E

B

Go ahead, I feel much better. That's good, yeah, my column detection. It says one hour so audience do we want to continue in a relaxed way? Do we want to wrap up top in five minutes? I'm. Greater continue me too.

C

I need to wrap up, but you guys go ahead. I I know about release tracker.

B

So then, let's probably finish it yeah, my apologies I just scheduled it scheduled it to 100 in the meter permutation. We.

D

Appreciation says 20 actor for me, so we get an hour 20 right so so.

A

I think I think I propose we go ahead at the casual, because, if people have to drop off, I would much rather capture release drafter into this video that we can then refer people and have them watch the video later. If they need to is there if their schedules won't allow them to stay. That's okay, Gavin and I can stay here, and even if it's just the three of us doing a recording, that's still very valuable. In my mind, Oleg okay, so.

B

Given that's cool I heard yourself on this, we still wanted to talk at beat them well. Gingka, say: oh right, right.

A

So, let's see so there were, we had talked about this transition. Gavin was there another step that we wanted a show, I love the migration process. We've seen how how easy it is to do that migration. Then we can migrate documentation actually from the wiki itself and I think you showed that in one example, I've found others were there other things you wanted to show gavest so.

D

I didn't get a chance to actually show wiki link because I couldn't find one quickly enough, but also, if you want to update the actual this page, you can click on the icon on top right. Look at hub. Oh oh.

A

D

We can quickly do this. It's a little bit. I haven't done this in a while, but if you scroll down there should be a PR.

D

Suppose that jsut point you for.

B

Say the once I can show the migration quickly if.

D

You hit quickly was it too quickly here before, if you get hit T to a file finder and then pulls digest holes into type, it yeah that one? So if you're in here you can list, this is the report Tori name and the Pleiades. So if you want yours to show up as pending, then you can add it to this list. Okay,.

A

Shall we so this is where I put the the fact that I have submitted the version column pull request? Thank you. All right, good I had missed that. Okay. So if I want I want to record for other people, okay I've submitted the credentials pull request. I've submitted the ones reversion column. All I do is go here, submit a PR to this repository and that will properly show it in the table so that others know not to bother with that that place. Thank.

D

You I know this is a completely optional step, but yes, right.

C

A

Link, you said you wanted to show you. You would be comfortable showing a conversion yeah.

B

A

You got a shared.

B

Emma great, thank you. Well, this demo isn't really prepared, but we can do it. Okay. This is my screen. Yes, okay, so we have some pages I just so you can see that there is a plug-in developer bit meditation and although we start engaging with documentation, three, it's both wishing to zero. Basically, this process goes and some do. Communication hasn't been migrated and, for example, here I just opened page and there is writing an SCM plug-in. So if you go there, you can see that it indicates with the development. Ii is in progress.

B

So basically there are some references whatever, but the section itself is missing, so we don't have anything to display here. So what we could do and just for the demo I found the wiki, which says ACM, plug-in architecture or something like that. I'll actually come yeah, so there is a name right, the same thing, so there is some things: I want to judge whether the content is up-to-date or not. I'll just show the mediation, so I think this page right now there is no images here. So I will use the click export thing.

B

You can sign your jakey's vkx portion, so the two which given presented and here we'll use ASCII dog because magic its website are you what's in a skiddo mode, and here you just click convert. So after some time we should get a ski dog which we could just put on the drink. Is speaking so I want you to say on this, how it works for Jenkins io, but basically you can do the same for plugins. You can just open them.

B

My in your favorite IDE, edit, the documentation and just a new request, and if you explore dogs export it in the format like we use for other plugins. So basically you can just placed them into the right folder and good documentation. Ok, so this is our documentation exported. You can see that we got a remarkably clean, ASCII dog file, so now markers or whatever I guess I was just like. So here I have this page open in Visual Studio code. So basically, this is the page views metadata via show.

B

This is a work in progress through fog, so what I'll do is I'll assume that we fix that I will remove this fog and I will put the content. So one other thing you can see that based so one problems. We have this fun dog, but it breaks the lines at eighty symbols at this or some symbols. We can adjust that, but usually our recommendation is to align by dots.

B

So, let's see what we've got I need to say that page at least okay I saved it and he, if I just below this page from drink and say oh yeah. Now we have content. This markup is still here because we need to restart the development. Metadata, isn't threatened on the flight waiting to say. Oh but yeah you just got the content in a markdown and I would argue that even from where they begin it looks, but in Jenkins I. You are then in week all maybe accept these faults, but yeah.

B

That's what we've good so now yep before the submission. I I won't be submitting pull requests, but so here you can see that there.

F

Sorry, can you see this? Can you set this to use one line per sentence for ask you know I, consider.

B

Doesn't support right now there are other options, but not one line per sentence. I submitted feature request, but it's not implemented yet so here you can see that we actually put some delicious, for example, the resident to team foundation server plug-in, but due to whatever reason right now, this links got lost, I'm, not sure why so it's probably a village in disinfection, so it's possible to when you start cleaning up some references. So basically we cleaned up too many of them. So these things will need to be restored.

B

I will just show it to you so I'm. Switching to line one line by sentence like thank.

E

You thank you yeah.

B

Then here you can nicely some recursion, because here we reference the plug-in we can, but again it's not something we want to do. Instead of that here you would recognize the plug-in, and here we actually would use Jake this wiki, we can just say plug-in TFS, basically to get the same result as we had before, because adjuncts, which is able to result for this mantra for plugins. If you hit this key so then you would just need to have to put the full name. So it's HTTP against.

B

Jenkins IO TFS tip as plug-in or something like that and we.

F

Have a macro for those tubes.

A

B

Jenkins I, yes, hopefully given wiki pages mappers, don't work so for plug-in pages. You have to write the full asciidoc on full mark down without mattress, okay, but whatever he here, you've got this I added additional link, and yet basically you can continue. You can clean up this page.

B

You can clean up, for example, these references, you can clean up sentences, some other bits might be missing and if you want to see such mentation, so basically there are two guidance guidelines for you. One guideline is for Jenkins say on. So, if you go to Jenkins, say oh right: github it works. So here on the contributing page, you can see a specific guide which was created for moving documentation from Jiang this weekend, so just step-by-step guide how to do that and how to export, how to submit pull requests.

B

So if you work on Gingka say your pages, you follow this guide for plug-in a documentation. The process is really different, but good know said that we have another guide and just a second. Usually it could be great to link the blog post from a speech as well is looking so I'm.

B

Just going to gently say your blog, and here we have a blog post recently, a plug-in documentation moving to dogs, so you can just refer to this blog post for guidelines, so there are some guidelines: how to do immigration and how to update metadata what Mark has presented and other things like pages, etc. We won't be trashing that, but yeah there is some stuff for that, and here's a link for full bed for me greatly plug-in the communication. You know automatic way is the jet to speak exposure.

B

Only if you do not like that other is to mono wait a minute on this page, so you can refer to these guidelines for the tail of automation, what to do and what to review, because we noted some potential pitfalls right hand, side, our migration guideline.

B

Okay, so this is it to be slugging immigration, any questions should we move to a ski dog or sorry. The doctor released.

A

After I think, I think we're ready to move onward thanks very much or like yeah.

B

Thank you. It was unwanted Emma, but okay at least we got something relation next time, we'll be submitting requests as well. Okay, so yeah. Let's talk about changelogs changelogs, which is another initiative. We've started in June 2009 Caen. So let's have a go and yeah all mine problem was change, looks because there are main places where you can find change, looks and Jenkins one obvious place is Jenkins. I, always change, looks for Jenkins weekly and don't see s reduces. Then you have jank this weekend.

B

So many plugins post they change dogs inside wiki pages they're in different formats, and it fits obvious issues where it's not machine readable. Sometimes it's complicated to understand. What's exactly there, you cannot find it, and actually there are many other ways to to use. Changelogs and thanks bug in maintenance use all of these ways. So yeah you can put change locks in your repository. You can use github releases, you can use external side, some plug-in vendors divert and some plug-in maintenance just change on at all so yeah.

B

There are many ways and that's unfortunate for jinkies users, because the attested they do not know where to find them, and it's quite difficult. So we had multiple options. We could have said that all change locks should be on the plug-in site or whatever, but instead of that, you decided to focus more on documentation as code for change lock as well and right now we wanted to target options. One has change lock and be in the repositories and another one is hit hard releases.

B

So, depending on your preferences, you can use one of these ways and be still keeping Co for in the communication. So that's what the current recommendation from jenkins documentation, special interest group and one of the things yeah, nobody really likes. Writing change. Loads of working maintain are awesome.

B

Sometimes we do not get the uses of plug-ins for months just because people don't want to spend time on the change loads right now and they're, basically inputs velocity of Jenkins as a project, because we do not get enough insides of well people create obstacles for maintain us as users. You have to go to history to understand what stage why take so long, that's at hand. It would be great if change logs be automated, so that do not spend time on there. They spend time on deliver stuff for users and then change load.

B

The bills presented in a way which is helpful for users. So you might have seen these change logs before, because many plugins have already moved. So this is basically what I present it's change loads. You should be modulated by a release draft as a t-top actions. The release drastically is a which allows to generate a change log and suddenly the abuses miss markdown, I described in this change.

B

Look and then maintenance can be said, one what they do with that next, because they can put the best example to change low can be, or they can just release this change, Lopes markdown rings, and now this tool is actually available. It's a bit hop up occasion, so you can connect it to your deposit or a victim and our project. The world. A lot of contributors actually contributed to the destructor, because Gavin did some patches also team and Joseph Patterson. They also contributed for logic as plug-in but yeah.

B

This is what you start using forging his project as a prototype and with the work quite well, so you can find it here. Basically, it's not restricted to junkies. You can use it another project since well, but the opposing hands we started to adopt acted on the organizational scale, because we decided that it would be cool if we invite across our area, all the repositories so how it works. Basically, it reads your pull request and creates a change log based on public quest.

B

So there are other tools which you create on the committee level for Jenkins. We discover that it's quite complicated because there is a lot of commits, been created and public ways provide more insight. So this draft takes request titles. It puts labels and there is a change lock on based on this information, and actually it's pretty flexible, so you can configure it. There are, is configuration s code, basically change logs I, just knocked down format.

B

That's what allows to move to change local mean if you need, you can configure it the right-hand side, your repository, but in Jenkins project instead of it actually configure the global configuration because release draft is a good application, is based on robot it's a framework for with her publications and one of recent report features. While it was a robot plug-in now, it's a part of robot itself, this configuration inheritance. So basically it allows to deploy some configurations and it allowed us paid a unified specification for change loads across the entire organization.

B

So if you go to magnet hub repository, so it's genkai say so: it's the storage for and submit a vehicle where we have product foundered. Support security policy is something like wait. I hear you can find it. There is also metadata for the destructor, not only metadata, which you have documentation, describing how to use it, how to configure it if you are playing in linking up, but also there is a configuration sample this configuration sample. This finds everything how we continue change loads. So here, for example, you can place some jinks.

B

We mostly use digitation or plugin. So we enabled in by default we have some keyboards, for example, new feature bug fixes which again configured here on the global level. We have template and we have replacers. So, for example, if you want to reference a JIRA, keep the pull request or C, or if you want to use some common trains like custom or package, it'll jinx fall around here. Just for example, you can use it a play service in order to configure this feature, and then you generate this change. Look so I'll also be open.

B

Yep Oh, like is it okay,.

A

If I ask a question, it is a shock so in using release drafter I think I had to define in my repository the labels it didn't seem like the labels were inherited from the parent that the label definitions were inherited, should they have been inherited so.

B

A label or a definition since the problem in github, because in github historically, there is no way to manage labels as integration is code. I just that we support few weeks ago, but again I it only offers default labels. It doesn't offer labels for this for historically created projects. So basically it had no particular value for us to use it in that way, but you'll be good. There are other alternatives, for example, configuration escorting image.

B

Here you can discover another Probot appreciations settings, which basically does some configuration, and here you can see that configures labels- and there is even my pull request- my comment to move it to the shady hub, so we could have done when rotation is called label for configuration has got for labels and other things in this way, but it's not implemented yet, and basically each monkey nyan has to enable labels and configure them on the on his or her own right now, but it would use it that default label stated by the trapper here.

B

So, for example, when you create new repository, there are labels, like enhancement or bark, and you can see them there. So out of the box, you already get some and later we can improve. Once we evolve Jenkins if I system, because yeah we can manage labels across the entire organization, but it requires some scripting, for example, github actions. But technically we can do it not.

A

Ok, so there's there's a potential in the future for automation, the the technique I had to use was actually okay of creating my own labels in the repositories. I have that are existing. There aren't new repositories exactly so.

B

We can improve it later, so here I'm, just showing you change local in real life. So for this plug-in the release was recently and there was no changes. So here you can just see released versions for the non released versions. Let's take configuration as code plug-in yeah. You can see that a bit is some I want to request notion by team. So here, if you click, you can see that there is a draft, so this is in common change, lock, which has been automatically generated, which is not additionally handcrafted. So it's what been generated.

B

We think that this change lock is only visible maintenance, I create para fee, foo to github to have a support of publicly visible change log drugs, but it's not implemented and I'm, not sure whether it will be implemented, but I think that it would be great improvement, but right now it's only for admins users to have to go to commit history to see what's in common, if so, yeah these change locks are generated automatically and cool. Think about that that configuration is set. The repository is just like this. It's yeah, it's just like that.

B

So with just a few lines because everything comes from global and this relation you can see there in the most of the projects which already adopted released router. So this global configuration basically helps minions to spend a lot of time. You just need to specify talk, template because maybe not release plug-in by default. You Jets are tiny before the version, so we cannot automate that and yeah.

B

You could have a tomato that, if released after support mean, but this feature is available right now, so there was no template for the visit or a name, so we could use the depository name after I read grades or whatever other mention that's right now. You just have to say what field, which is probably not a big deal, and you get all these change locks running which release okay.

B

So yeah I will just skip this page. So what we're doing it to you? If you want to use it, restructuring your phone, you so, firstly, you need to release in able to release it after there are multiple ways you can go to this register after page, which just expects everything step-by-step. If you need it but yeah. This is just quick summary, so you can release enable it as a bit hot publication.

B

Basically, you just go to this side and if you have admin permission in the repository, you can just say that I want to enable it. So what's going on okay, so you just opened this page, so you can see that that is number of organizations. I go to Jenkins I need 20, my password, and here you can see that there is configuration so as I'm Jenkins admin, so basically I can enable the release drafter everywhere, but you as a common user.

B

We will likely be able to enable it only for your repositories, where you're, adding and by default. We now get. You can't admin permissions to plug-in linking us between de repos. So here you can see that there is 127 repositories which adopted revealed after so it looks like a big number, but it's moving a 5% adoption across in the plug-in ecosystem. So we definitely have something to improve I'm.

D

Very happy to see the truck Norris plug-in has released Raptor yeah, it's our most important, plug-in yeah.

B

You can see that there is a lot of plugins that also almost all developer tools, which is merged to reduce traffic because for development tools we had even more difficulties news, maintaining change loads and now it's just take a button and you get this changeable. So hey.

A

I was I was rigorous in maintaining the gate, plug-in change like seriously and the release day after change. Dogs are dramatically better dramatically better. They look better they're, more navigable, there's so many things that they improve because of that layout. The hyperlinks are more useful and.

D

Also throughout, if you go to the very top I like and you do, the watch drop-down.

D

The patreon now there's a watch button. Alright, so one of the cool things about release drafter is you can now watch for releases only and every time we release happens and a new tag happens. It'll actually send you a notification, probably not a good idea for a league who gets a thousand and two hundred of North cases a day. But for me who gets a lot less, it's really nice to be able to watch releases on your favorite plugins, and then this is hooked up to that which was a lot nicer than your update, Center.

D

Suddenly getting a new update and you're like what changed yeah.

B

Moreover, you so, if you're not subscribed to this visit Horry, you have this banner, so everybody who's visiting, featured image loads. You will be automatically over offered to subscribe, subscribe to upbeat, okay. So let's quickly finish that so yeah.

B

If you didn't have admin permissions, you can ask us by just waiting in free ticket and then it will like to just give you admin permissions, because we fixing it up slowly across the organization and the third way is to actually use github actions and because yeah in some cases we head towards support on github actions, for example for Gradle plug-in, because there is a bug in the recent version in the current version of release, drafter github application.

B

So instead of that, for example, in github action, we use in Gradle plugin we use with affections to generate, and you can see that there is a fork for Jenkins previous draft, which basically fixes a few bugs we heat, and here you can see that the same changelogs I mean actually generated by heat affections. So.

A

Now is there a is there a benefit to using github actions? Is there something that that would that would benefit me? I, never, never. Consider engine have actions instead, yeah.

B

So there are two benefits: one benefit that you get execution log, because these the top application- you don't get one so here you can go to run actions and you can see that the data is local and whatever, because she executes and if something fails you can develop there. Another benefit that basically it runs on github actions. So you can understand when the job runs or not.

B

When we use github application, you basically rely on being listed after service to execute everything correctly and with this author, or whatever the changelog may not be generated, so he its monetary minister,.

D

There any chance we're going to add this to the default plugin groovy file for CI Jenkins as well I'll.

B

Be good so basically we could run the new draft ran right hand, side, Jenkins pipeline. We don't do that because yeah we had some issues with Jenga stability over past months, but technically we could run it and then it will have Jenkins port submitting Jimmy's draft. So we could do it so now. Jen can support, submits us in statuses like this ones, and we can teach it submit these drafts as well. So yeah we can. We don't do it right now, because it would also consume github right limit, which is quite limited resource Beyonce.

D

Jenkins IO, but.

B

Yeah, technically we could do that. Okay, so let's finish the slide back then yeah. You can also add labels. After so after enabling repository will start getting drugs, but we still need to categorize not released changes to get offensive change. Look if you don't like labels, you can just disable them by the writing the configuration and then you will have no cookie bodies, but it's totally up to you and you can. Then you will need a bit pigmentation pointer change lots so what we usually do in our plugins now.

B

So if you go to total strategy plug-in here, you can see bridges, sometimes I get a chart and also a biggest one, with bridges links you to change log, and then you just maybe get here. So they did value of these bridges that this be just accessible on the plug-in site as well. So here they are.

B

So, even if you don't what change locally stick yet, you can see that in these bridges right away so yeah, so we recommend to update plug-in documentation so that users can find these change logs and lately we will be injecting additional support for the plug inside and after that, you will have to release at the plug in because yeah you need to attach to change, looks to something and then you will need so. We had an example yeah, but would you mind if I used a bit buggy just for the demo? No, no you're!

B

Welcome to the please yes! So here we can see a draft of version 4.1 Dogzilla, by the way it Congress with photo zero release. Forget yeah. We have change log, so this change lock is basically.

B

Just a draft generated based on a pull request- titles so making here you can improve them before not junk, but ultimately you can. You may need to do some more kisses. So, for example, here let's say we don't so when I hear quotes, we don't like them. We can put something quite a bit in markdown, so just copy them into the changelog and then impute appears to determine- or you can add, additional hyperlinks. You can put additional data and we also recommend to put summaries if you have want to highlight something.

B

So, for example, here you could hello world something quite good after that we can all say edit label. So by default it will inject labels. There are some parts, but here, for example, we can create label. We just shouldn't publisher, this change, loop and sash way, but yeah. You can do that and you should do that because otherwise this won't be associated music, particularly realistic.

B

We created by mmmm, and then you can just publish this 19th change log and then all the users are subscribed to the news notifications delegated so basically, even before they see that in their descendants. They get notifications. This a change log summary, so they can see what exactly was released.

B

Okay and you just publish it, and after that, you get these change locally generated and available to your users again drafts not publicly visible, I'm, not sure. Well, hopefully we will change it, at least for the least laughter but yeah. That's the kind of state of affairs and github.

B

So some highlights almost all development tools, at least all development tools, which we touch the user to mister. After now, for change loads, so plug-in poems and other common tools, you use a plug-in maintainer, they already switched to revealed router I'll have a few minutes left, so probably I will just show it. So this is a plug-in home and plug-in form when we use it here.

B

You can see that the change logs, which also generated using previous art so same as before, and these tools, these change logs, are really essential because yeah I'll just take dependable inertia because dependable is one of the tools it actually sexually able to food change loads. So here's a better example because there is just commit history but stay a bill of materials. Maybe we'd like something yeah, okay, Bumba genie, key to version, 1.3 version 1.4, and he in the boutique list. We have changed notes. We shall surprised the generic, but with draft.

B

So there is some overlaps between to date, which basically helping you as a man and to understand what changes without going forward so yeah. There are advantages.

D

And that code and dependable is really complicated because there's no standard for so release notes is cool, but then sometimes they have a change log option and it's pulled from like 14 different sources depending on what it's there. So yeah release notes are very supported. For the part. It's really nice yeah.

B

So maybe we will do something like that for Jing is playing inside. Maybe you just take dependable core, because it's open source well, who knows but yeah, is yet to be seen so yeah. Now we have more than 100 plugins, which already move to release d'arthur. So far so good, we received some pull request to change the default templates to add additional labels, but generally it gets adopted well and you can contribute to this default resources.

B

It's just one request on github and we have several pull request: several contributors from Jamie's projects in the rap tracker system, yeah thanks Gavin, my keys I just contributed by issues, and somebody fix this recently so but yeah, it's too good. So in 127 repositories, as on the morning, we and Counting, and actually we have some plans so first the integration with plug-in side showing these change locks on the bug inside. If my wish lists to also show it and Jake is web UI.

B

So if you go to point in manager, you can also see the change locks there so that, as a user, you can I easily access this data. Again, it's not clear how to do it without it happening, so maybe we will have to catch this information plug-in side somehow yet to be seen and yeah.

B

Then it's also very would be great to have a big a to change lot because, for example, if you use motion Li, if you use pipeline I, guess it's a challenge sometimes to understand what exactly was fixed and way in which exact the company sofa blow. She needs a bit better now, because it's a mono report, but here for pipeline it's hard to find the things. So by aggregating these change loads, we would be able to easily understand what exactly changes or plug in e users when they do multiplet and yep.

B

They will be liked a lot of changes in change log formats. In addition to that, we are also working in the Jing he's gotta change, law, automation, I'm, just not mentioning in there because yeah, it's a separate story. So if anybody is interested yeah there is, there are links, and there is the communication right hand, side our github repository and you can contact us use and see channels and like Geetha or mailing list. So if you have any questions, just let us know so any questions before we start wrapping up.

B

Okay, so this meeting went over time we beat, but again it's the first time we do a developer, Meetup, so yeah I, think student group, so yeah Jenkins needs you and actually we need contributions because yeah there were a lot of changes and the new that Oktoberfest BBC hundreds of contributions and doesn't documentation to what date migration. But there is still a lot of things to do and we seek help from contributors so yeah you could help just by talking to us and the documentation, see because you miss feedback about the documentation.

B

You can help us with slugging me in creation, as given shown today, we still have more than 1000 plugins to degrade. So definitely there is a place for contributions. Then we can immigrate gentes io documentation like presented. They, you can help use mutation tools like agenda, speak exporters at me in a it's on github.

B

So if you want to improve it, for example, but they the conversion or whatever just contribute a pool request, or if you want to use it in another project for what it was because there are other confluence users who want McDade, then we have going inside and for everything. We've also appreciate the reuse and copy editing. If you go to the documentation special interest group page, you will be able to find things to put the quests which I wait for abuse.

B

If you are plugging in maintainer yeah, we recommend to move the documentation do get to github. It doesn't mean that you go become reliant on github, because it's one of the fears right now, because the communication is just it. So it's portable between other sources and yet used to for the control that it's not like. Github pages is not like github wiki. You have full control and set your repository. You can follow the maintainer Scott practices and it's pretty good same for change loads.

B

You can move either to github releases or to change locally, and they it's something you could do and if you're already there, you can just add fun things, like example, bridges, repair topics, links with channels like Twitter, so that your users can reach out to you computing with mediation and whatever, as member of the communication, see, we really encourage you to improve your documentation for most users and contributors so that in the future we can facilitate, contributes to the planet.

B

And if you have any interest to meet us yeah, we will be devoxx wall junk this world. There is hot Fest on December, 2nd and this hot fest. We already have for some documentation related projects, so we can just sit together and heard something a belliston tribute or summit on December 3rd and exist a little bit retrospective. Forging is we cottage, but we will also tell how we could do better next time and whatever, and at least they will be other topics and, of course, community booth.

B

So if you just go to the conference, even get me mark and I are going to join as well and.

C

B

Maybe the next time but yeah you can meet the Jenkins contributors. There ask any questions about the communication about whatever and you know, because there are discount codes for those who contribute and speaking meetups, so don't forget to use them contacts yep. We have documentation special interest group page and basically you can go there and find out more information about the special interest group about the projects we are working on.

B

You can see that in the mediation project there and you can also find connection beings, so that is made in place that there is chart and there is a link to meetings. So you can follow these resources and order to join our meetings. There are usually on Fridays, but identities meet up and you can join and any contributions will be much appreciated.

B

Okay, I! Guess: that's it! For from me. Are there any questions which we haven't covered yet.

D

No people been answering all the things in okay.

B

Right so like any additional commands, anything else.

A

Yeah, thank you Oh, like thanks very much and thanks to the community for the contributions that we're receiving. That's wonderful. Thank you. Thank you. Yeah.

B

Thanks doll so yeah we had a question from Bobby about plug-in ownership. I we could took take it off for a line or we can briefly describe discuss it now. I'm.

D

Gonna have to go so I'm.

B

Gonna go with you. Thank you, so I guess we just closed down because yeah there is a developer at least discussion of all the topic and right now the situation isn't that Pleasant there so right, yeah again thanks everyone and yeah. Thank.

A

You everyone I'll end the recording and.