Jenkins Documentation Office Hours, 21 Jun 2019

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Docs SIG 2019 06 21

Description

Jenkins documentation special interest group, including demonstrations of CommunityBridge from the Linux Foundation and the latest enhancements to the https://jenkins.io/ web site infrastructure.

A

So welcome everyone to the documentation, special interest group. Our agenda for today looks like this seola. Can you see my screen? Alright, it works. I. Think that's a great answer. I like that. Okay, thanks.

A

Alright, topics on our agenda for today include preview, a review of previous action items. Google Summer of Docs retrospective action proposals was proposed. Any community breach was proposed to the topic. Then I'd like to do a demo with the latest Jenkins at I/o improvements from spinach connection, a bunch of really cool changes that have been made. We've got docs in cig infrastructure status report, the plugins site and then latest data on contributors to the site, and those were the topics that I wanted to be sure we covered.

A

Are there other topics that need to be added to the agenda? I.

B

Think fine yeah me neither one something's about my topics, so the garden community bridge fruit project status, actually I've performed status, update one week for two weeks to go the folks not reached sick and they have been waiting for recording to be published. So maybe it's me. It makes sense tribute together with stakeholders once the video is published because yeah otherwise I could do the same thing. I mean if you want no.

A

I so I think that's a good one. We should just how about would give me an action item to link to the sink to that SIG's recording when it's available.

B

No yeah, basically I control. We probably just second I'm checking my Logan.

B

Yeah I think I. Can the mother.

A

A

That's great if you'd be willing. That's that's wonderful! Let's take that then we'll just capture all that. Okay.

B

You know just the Austral son beats okay.

C

B

C

Right so then great.

A

Alright, so let's go ahead then, on the action items, I've still got the action item open to submit the docs project ideas as a pull request. That's just a gathering exercise for me: I will get it done.

A

Oh like I'm, like google Summer of Dalek retrospective action proposals. I had not captured any notes, major notes, I think we intentionally deferred. You want to defer again what how would you like a hand with that back.

B

Yeah so I think that allows me to go through this yesterday, because yeah basically forgot, who would have it on one of the action items is actually community. We should you know below nuit and other communities were run about, having established after green teams and stuffing it's not month or something like that.

C

Great so, let's.

B

Addiction item for me: I'll get my on my own. If you.

B

Sorry I just forgot that the document is also open.

C

A

C

A

That I need to practice adding action item. So thanks for letting me do that, that's great yeah.

B

No worries, oh, you just need to know all the personal emails of people right exactly.

A

Okay, so then, on to the community bridge topic, yeah.

B

So community rich I can probably just finish a bit and show what we have, because that.

A

Which I need to stop sharing there we go, you have, you should be able to share. He should.

B

Be able okay, do you see my screen? I do okay, so he a community Bridgeport fell.

B

B

Me Twitter strange page, yeah community bridge is a portal deployed by a Linux Foundation in order to help connecting various participants of open source projects, in particular people for interested in mentorship people who are interested to contribute and holo to fermenters and also company individual sponsors who want to facilitate some projects. So basically it's a combination of project hosting portal and crowdfunding site and yeah.

B

This side has been started several months ago over it's still under active development, but there is a number of projects already reached there, so you can see them here, but yeah the most of all the projects look pretty similar, so some projects which proposed proposal or just propose to connect to that organization. If you want to do something and yeah the way it for people to join mentees and his, for example, information about the mentee funding. So here we can see that, for example, hyper ledger for this project.

B

They have found funding for one mentor for 190 and they're. Looking for more I'm, pretty much like a bet, so you may see that there are two different implementations so one, for example, hyper ledger. They have one project post and both project so, for example, here at reputation for project management in construction or something like that. So it's one approach which is been reused on the side. Another approach is just to have one project for the communities, which means that whoever joins they're welcome to join and yeah right now there is no information for Mentors.

B

There is no information for mentees, so yeah. This is the kind of stuff but having this stuff is also important and we have actually the same stuff for Jenkins, so we're my projects, so he it's listed on the list, so you have Jenkins project I just spend some time enough to create the stuff. So he again, you can see that we have no mentors at least I'm, not sure why, because I'm listed as mentor there is no meant is found in I'm, not sure why?

B

Because if you follow the literature, one of our contributors actually apply doesn't maintain but yeah. Basically, this is what we have. So just a portal offers a if you want to contribute to Jenkins feel free to reach us reach out to us and we'll see what we can do. What I was about proposing is to consider splitting multiple projects, for example, Jenkins documentation, so, for example, patients we don't participate in all season of dogs.

B

We could have a dedicated project target which targets Jeff is the communication, another yeah, or we could just make it most specific in the project. So, for example, here it hits now Jenkins also and yeah. That's it.

B

Setting up a program is quick, but if means we can do so or we can just, for example, attract momentary scale from some value mark. If you consider to be mentoring, some conditions I can just invite here to distract, and so only we can just review options and maybe keep of some kind of a problem in the future. Great.

A

So yes, I would like to be a mentor and so mark or old wait at gmail.com.

B

Okay, something like that I guess so, yeah and just didn't here as a mentor and then theoretically, you will get an invitation to this portal.

B

So, let's it so regarded requirements, actually I just set requirements. So we need acquire a person to reach out to us to have conversation to send us a kind of introductory letter, but that's it. So we don't have academic restrictions due to all those reasons and yep. That's it nice, okay!

B

Yes, so the three key point about that that I wasn't able to find any example of a working program and community bridge, so the site is under development and it's the machine to work but well, for example, for Google over season off dogs and for the communication special interest group. It would probably try putting several projects here or one of the projects is, for example, Jenkins. We can do Jenkins. The fermentation McRae do Genki sex documentation.

B

If somebody wants to and then have a set of projects which become an elite advertise, for example by community channels or whatever and.

A

Now you indicated that there been some surprises, because it's currently the applications self community bridges, inactive- is actively being developed. Is.

B

Yeah I'm not sure how activity, but there are just minigolf yeah, for example, we have publication here, oh good, okay, that was one we just recently discussed in Kidder. Okay. So that's why I don't think it's private because he had application is here: I won't go inside but yeah. So there is some application. There is a kind of cover letter here.

B

So, for example, he we can probably do something to note the two example pending because right: okay, something like that and here available to me study enough the to get everything in trees and you can have from altercations like that.

B

Thank you. Thanks very.

A

B

Looks very promising yeah, so I'm not sure how far this community, which is going to go but yeah I, think the platform they smashed by Linux, Foundation and I believe it means that they mean business. So yep I think that we could try using to this platform. Obviously we have open issues, for example, about funding because yeah you may see that there are crowdfunding features so that, but for us these features are not accessible at the moment because in order to yep so yeah that was some funding.

B

So in order to get Jenkins here and to get this funding being it to be a part of the core infrastructure project, just a second.

B

Structure yet core infrastructure initiative, so it's another program by a Linux Foundation. Basically, it's an aggregation of various companies which try to push towards the system for for projects, including open-source projects. For example, there is a batch program which is designed specifically for conserves communities in order to measure criterias of calling infrastructure and with the project list from the list. So, for example, there are some requirements which we have already debuted meet with Genki security team.

B

So it's not exactly a trivial talk now a good jenkins in this project, but you may see that there is quite a list here right. We have having Jenkins as a part of core infrastructure project. Firstly, it's a pretty good quality metric. It's a pretty good thing for promotion, Falls, so I think it would be interesting if the project is ready to invest time.

A

So this would be a this would be an extra level of her and it would be project wide across the a large portion or bigger portions of the Jenkins project. You said security would have. Does this also have some requirements on the infrastructure that we've got to do some safeguards against our current infra? No, it's mostly about security processes.

B

A

B

Well, some monster is in the list: I didn't, remember you, security, team, I, believe them, oh, my god, I am NOT I, don't think I am anyway yeah, but yeah. Basically, there are some requirements today which require strict review because changes security processes depend a team in different way. So, for example, there are some expectations for this closure time and other things which is fine, but here we need to ensure that we comply with this process.

B

So first finding is not available at the moment and we would need to do to work on that in order to get that and here, for example, one of advantages that currently doing foundational diversity program and other things and the DHD double funding for particular areas, etc.

B

Okay, so yeah that's what we have but yeah. Basically, we need mentors and we need people who would be interested in there.

A

Great, thank you so in listening and listening mentors is something that shouldn't be too hard to do, inviting people excellent. Thank you. Mmm-Hmm.

B

Okay, so anything else.

A

Nothing no other question. For me: it looks very promising mm-hmm.

A

Thanks again for that, so old, like you had mentioned, that you might not be able to remain for the call thanks for that coverage on community bridge mm-hmm.

B

A

B

But you know there will be some yeah if you do these the most I'm happy to me. Some.

A

Okay, yeah- that was my next stop, was I wanted to I, wanted to highlight some really impressive work from spirit connection that he's done for the Jenkins that IO site in the time period. Since the creation of the daxing.

A

It's he's done really some quite nice infrastructure improvements so, for instance, social media pages. Social media now includes images from the pages like this one, and here you go, this Jenkins needs. You came just because I shared a page on the on from the Jenkins that IO site thanks to his emigration of Open, Graph and images. So if someone shares, if someone creates a new blog post, they can provide their own image that heightens the engagement of people in the social media community, and this particular one.

A

Let me highlight a specific capability of that particular blog post or that particular item mm-hmm. For me, that was a that's a very nice addition. Then he's also done some nice fixes in terms of the layout on the pages when we bed videos and used to be that this Jenkinson android page had a very poor layout for where the video clips were placed fixed looks much better now, mm-hmm in addition to that, he's had an author pages.

A

So if we want to see let's take Oleg we're going to look at everything, Oleg has written and here's his author page on the Jenkins, not IO site, now automatically generated automatically maintained, shows all of the blog posts that were posted by him over time and includes his biographical information.

A

Same thing exists for a Roman Rodriguez Gil, for instance, and his his contributions recent contributions. So the author page has been a nice addition that the Vinick made to it. Those same author pages are also linked into our special interest group pages. So the docks Zig, for instance, lists a number of participants and members- and here, if we look oh, let's see, Ric is a is a participant and if I click that link it takes me to his author page. So racially.

B

Highlights one program: well, not a problem and because Ric has had Chinese symbols in his metadata so before that he had no problem because we are showing it hop ID by default. But when the change was applied now we see his Chinese name Lynch in symbols person he had no probably dead because he but yeah there was some difference in behavior and you've seen it for multiple.

A

People: ah okay, now, is that something that needs a fix then or is the new state, acceptable, I think the winning state is acceptable and then we can punish it if unit great excellent. Thank you thanks for the insight, so the author pages and then there have been accessibility, improvements for people who are using screen navigation. That may be visually impaired, for instance, so, for instance, on this page, tabbing now has behaviors that you might expect as you navigate through hey I can tap here.

A

I can tap up and down open a page by hit the enter tab in that page. I can cause that tab to move down, and so accessibility has been improved by virtue of tab navigation being better.

A

Now, there's again still work to be done in those areas always will find new surprises. He also fixed the blue ocean page. It had a completely different styling than the other pages on the site, and so was missing this block at the bottom. That is standard on every other page we had that's now fixed and the special interest group mailing lists are now automatically generated and placed onto the mailing list page. So this meaningless page lists the Jenkins user page, this jam pages, other discussion lists and now at the bottom.

A

The special interest group Manning list generated directly from the list of special interest groups that are maintained on on the Jenkins at I/o site itself.

A

So really nice additions from spinning so grateful for what he's done for us. Any questions on.

B

B

Just LEDs and how do I, open, tribution and even out into.

A

A social media right and I think those are all motivational things that help inspire people: hey it's worth helping and show just how much progress. We're making I assume that then one of the next upcoming places where we're going to see progress is on the plug-in site, because we have a pending pull request that improves the plug-in site and lots of interesting discussions on the on the get er. Channel are no on the dev list, actually about things that we can do to make the plug-in site better.

A

So there is an improvement dock here where we're trying to capture some ideas, and we've already got our first pull request. That's proposing to improve the the reliability of the scripts that generate the plug-in site and what connect noted was that he's decreased. The failure rate from about 10 percent of pages, failing to something on the order of 1 percent of pages, failing to generate correctly yeah, one.

B

Way to think about the middle east side.

B

So one problem is Jenkins. I/O said nowadays that basically this site isn't really maintained. I mean it has been originally developed for Jenkins 2.0, but it was thais again and the sins of the times. There was no active containers for this component, which impacted a lot of our efforts. But here, for example, now there is a developer million straight from my avian about having.

B

It had a business from the website. Yes, so maybe we'll be able to reform of the effort lost time. I was checking about. It makes sense to do something about this site. I discovered that there is no maintaining that and basically no interest to get. The change is still debated by the infrastructure team.

A

Yeah so and I think I think the the pull request that that phrenic has submitted is one that I think I want to review. I know that Daniel Beck had commented on. It he's not sure when he'll be able to review it, but I think I'd like to review a test, drive it and see. If I could then use that test drive to propose to Daniel hey, let's merge it.

A

It's working well for me, but that's because I I would love to have some improvements to the plug in the site, but you're right it needs we've got it. We're gonna have to have people willing to do it. Thank you. So I don't have anything particularly to report on the dock. Sig infrastructure status report. One item that is required for a special interest group as it needs to report to the governance meeting and the governance meetings lately haven't been happening, so I assume that that requirement will be lifted or I'll, send it by email.

A

As a summary or who rely on these meeting notes, yeah.

B

Just some of it for the developer, Middle East only writing blog posts. If, for example, you have a list of things it changes from the Jencks website, maybe even me he seemed impossible. Well, he definitely worse assignment amenities right.

A

Let me put that as an action item for me.

A

Okay, yeah. Thank you. So, as a final item, sorry.

A

Excuse me, as a final item, I, wanted to highlight some data on contributors to the site. I've been capturing, this data and the cloud native computing foundation added the Jenkins that IO Duc site to their graph on abased data collection site where they're collecting various metrics and gathering of cons on open source projects and one of the ones that we see here is I, can show it in the the full context is time from opened to merge.

A

So how long does it take them for a pull request to arrive in the queue on average and then be merged into the site? And what you see? This is a 90 day view and what it shows us. The middle line is that median time from open to merge and in the last 90 days, we've had an improvement where we were at points earlier between 10 and 10 up to over 10 hours between submission and merge, as the median we've now decreased that to more like on the order of something over an hour.

A

So for me, there's an improvement and this graph seems to indicate a real improvement. The CNC F site provides other metrics like this and there's a hyperlink in the graph. If anyone is interested in taking a look at it now is. Does this tell the whole story?

A

No, there aren't any software metrics that tell the whole story, so don't don't put too much credence into any specific measurement, but it was fun to see that, in addition, we've got measurements that show we've got more contributors arriving over the last month, we've had additional authors, contributing that hadn't contributed previously, so I think we're getting some growth and some development in the Jenkins at I/o site.

A

Those were all the topics that I had for this meeting. Unless there are other topics, Oleg I propose we close the meeting.

B

On Sonic, there is no topics for me right now. What we could consider for the next meeting, maybe join meetings, advocacy and I wish seek, for example, but yeah man sure we don't like half of the content is actually about a dog stand out fish, so maybe we could do some collaboration there good idea, that's a good suggestion.

A

Yeah I'm not sure that this meeting itself is being especially effective and so in collaborating with the outreach sig may be a much better result. Just give a brief summary there of progress. I don't want to disband I, think we're the right doing the right thing and we're getting the right results, but the meeting itself doesn't seem to be helping with that objective.

A

B

That meeting clear is helpful but yeah. The goal is to have more people on the call and now, since we don't do Google season of dogs, we and we don't have any full-time contributors, documentation and the drink is community, and it means that yeah we either encourage people like has been a call other to participate and we get a set of people who participate or maybe immediately. Just company is not a special interest box in order to again have mostly coolers here right.

A

Right and that may be the that's a good point- that other special interest groups might meet just the benefit of a reminder: hey if you document what you've got or blog post about it. You can help your your special interest group and the docs record yeah.

B

They kind of meeting fatigue because here now is Google Summer coated says that I have more than ten community meeting so week.

A

So yeah right understandingly, but thank you very much for your contribution. You're doing great things for us. Thank you. Thank you. So I'm gonna stop sharing and end the recording.

B