 Welcome. This is documentation office hours. It's the second of September in Asia. And let's get started topics I've got on the agenda include action items, Google summer of code I wanted to show a demonstration of latest results. The upcoming release September 7 of 2.361.1. October fest documentation contributions was a key one for me. Are there other topics that others would like to add to the agenda. So let's see we previously done pending poll requests documentation. In particular, the adopt modernizing a plugin. Progress report might be worth giving. Meg or Kristen anything that you wanted to comment or the any topics that you wanted to be sure we're covered. Kristen I assume you'll be interested to see this pipeline step stock generator one. Yeah. It looked pretty good. I got on Tuesday's beer. Yeah, our meeting that we have together. Man showed off like his code and it looked pretty good so. You see that everything was reduced. Well we'll show it we'll show it on the live site now. Yeah, there's there's still some bumps, but the bumps are minor compared to the improvement so exactly. All right, great. If nothing else and let's go ahead and start through the list. I still haven't archived the docs mailing list that's pending, and I still owe a couple of blog posts. I'm not sure I'm going to bother with the contributor summit when I may just drop them both because I've got other blog posts I've got to do upcoming as well. We'll see. Any questions on the action items before I get into the interesting part. Let's go to the summer of code then. So VHAN Thoras work on the pipeline steps doc generator is now live on Jenkins.io. We had during office hours Europe about 12 hours ago. We had to work through an issue where the site generator was making a mistake and not doing a recursive unzipped. Now, and so let's look at how it, how it looks and feels so pipeline steps references here. And if I were to search for checkout finds it nice and quickly here. I click this one. Notice how quickly that page loaded. Yeah. Boom, it's there. Now this is still presenting the same page. However, when I try to. And so when I click on, let's click on a less popular. It's SCM like harvest. Okay, there's it shows it opens and closes. GeneXus again opens and closes. But when I click one of the really big monstrous ones like get SCM, it converts it to a hyperlink. And I click the hyperlink and it opens it in a new tab. Now that opens it in a new tab is I think a little bit of a surprise that was when I had missed during review. I think we want it to stay on the same page but notice that here it is and it's much, much faster. Likewise, let's see what was the one that that Veehan showed Veehan showed a different one but which showed the same exact behavior it was that hey the pages load much faster. And the system is much more responsive because of it now Veehan did note that there was one page that surprised him in the in the process and I think he's still investigating that but even with and that page was just look, it had an unexpected layout. Let's see if I can find his comment in the poll request. Let's get this we need pipeline steps doc generator. I think it was in this poll request that we merged just today. Not that one, not that one this one. Okay. No, it's not there. I don't see it here there was a comment somewhere from beyond on a. It was something from, I think it was from Jason. Maybe I can find it that way. Nope. No, that's not it that's extension points. Sorry, so there was a pipeline steps. Maybe it was here from Jason. I apologize. I don't. Oh yes, build steps from Jason builder. This one I think surprised notice that it's taking quite a while to load and notice the odd layout there on the top right hand corner. So so that one that one isn't that one's imperfect. So it came in and but still the page is not quite so long load time still loading still loading still loading. The page itself somewhat perverted is that the problem. I don't know. Well so so what we see here is this thing has a very long list of of classes. And some of them may in fact be quite large. I don't know for sure but I suspect some of them may be very large. So it's not clear to me what's going on causes this page to behave like this I'll make a note of it in our notes just to be sure we've got it. This is the, I'm trying to remember the plug in that we got burned on for last years. She codes Africa, the one that has all that stuff in it that I actually had thought was part of Jenkins itself chickens Corbett it's actually a plugin. So let's let's go find it. I'm losing my knowledge here. That is the build step I believe. So if we look at the pipeline steps reference and search for build. And then we look for the build step. Come on. Now I got to find the build is a real you could probably tell us the next one he was looking to tackle or just kind of like recommending some actions for that. So it was suddenly began with a P. Well, okay the one that the one that I was accustomed to really was named build, and I thought it may have been even in the build steps. It's just the build, like the actual physical build and so rapper. It's that one that's really really big one. Yeah, but I'm not seeing it here right there is, there is one. But in this case, word based search didn't give me what I oh wait a sec maybe if I do it like this. Build colon. Then at least it chooses the words that end with the word build PC bill under if you do space build. There it is pipeline. Yeah, I knew it began with a P. Boom. There you go. Okay, I was like, I think I know you're talking about, okay, this is a huge one. And we've actually, we've been kind of talking about in the our little meeting for summer code about like what to potentially do here. It doesn't have great content. And that's what we ran into last year is we didn't have people to help the people get it get better, you know, it's been there for so long nobody's interested in it just there. So I think the other problem is that this isn't the problem isn't the build step plugin itself. The problem is every it pulls in from tons and tons of different plugins so every single one of those is most likely from a separate plugin. So it would be a dependency like requiring to go into the plugins that you can get those things from so like patch parameter value parameter value. So the changes like those are all coming from different plugins so the changes to update that documentation has to be inside of those plugins, and it's just kind of just massive. Those problems are there always this still looks much better than the old way. Well, and notice notice again back to note notice the benefit of the load performance that page is loaded. If I show the show the page source. Okay, the scroll bar size gives you a hint it's not a huge page anymore. Previously it was enormous. Yes, so so the split that has been done is is a dramatic improvement. It didn't however magically make the content better. Right, right, right. But it is still an improvement. Oh, absolutely. Yes, clearly. Yeah, so, so, but good, good indication that yes it's live. Part of me still wants this jump to a separate page resolved all log of an issue for that, just to invite. VHON now we're almost. But I kind of like the looks of it also. Oh yeah. Yeah, I agree. It presents well. Now I'm not sure what's going to happen here this will be an interesting one. The get plugin is eventually going to replace this awful syntax with a simple. Yeah, only years. We have a pending pull request, but I don't know what that will mean in terms of the change of this documentation I assume it will still be at this location or it may exist in addition at that location. So that's one that remains open because until the until the new release of the get plugin is delivered with that merged and said we won't have anything to test with it. But yeah, yeah, I, he did an amazing job. Beyond is done an amazing job with the documentation and like the layout, like making things so much faster. It's, it's been a great project and he's done phenomenal work. So, very, very, very, like it's what he's done is so cool. It's been so nice to have them focusing on that layout. And with new ideas for that are like, you know, looking at it with a fresh set of eyes and having some good ideas and then being able to work on it has been wonderful. Yes. Good. Excellent. Thank you. Anything else on the Google Summer of Code projects. Oh, yeah. And I just had a conversation with John Mark yesterday, and he's proposing us to to do a final lines of presentations in September. Oh, yeah. Okay, so late September. Online meetup. Chris was that what you're saying. Yep. Yep. That's it. Yeah, great. Excellent. Thank you. So, and that's four projects. So congratulations to all of them. I assume that it looks like they're all foregoing to pass. I know the one I'm mentoring is doing great. Kristen's a mentor on the other Chris you're a mentor on one. So we've got three of four projects represented here already. Okay. Congratulations. Thanks Chris for your work on it. So next topic is actually a Chris topic as well. So this is the release lead for Jenkins 2.361.1. We've got a pending or an arriving call request for one more backboard right. Yep. And the change log. Change log will need to be updated for that backport. The change log, the upgrade guide. Need need need further review that's a me, though we did a good review earlier today with pre prior to Europe office hours. Any concerns so this is next Wednesday that it releases. This is the one that requires Java 11. Yep. This is the result of multiple, multiple months of work from many different people to get us to this point. Congratulations to everyone. It is looking looking quite good. All right. So next topic that anything else on 2.361.1 Chris from you or from others. Because I'm bad at counting. Okay, great. October fest then is coming so starts October one ends October 31. And one of the things that I think we might do effectively today is do a quick look to see at the documentation tasks that should be flagged as good first issues, and note them so that they're properly labeled for the first two days. The challenges I think some of the ones that we've already got labeled that way are wrong, that we've since shifted in a way that they're no longer good first issues. Are you willing to spend time today looking at them that way. Absolutely. Okay, I'm not leaving early today so I'm here as long as you need me for a change. Oh great. All right. Okay, so good first issues that we have right now include. Okay, so these are plugin. Okay, so this one. This one is a plugin documentation page. And so that's, that's actually viable. So let's look at it it says, Hey, here's how you do the migration of this page. And the plugin is liquid base runner. Is it still an active plugin. It's, it still exists. It's documentation. On the on the wiki is actually has much more content than what's presented here. Yeah. But but now wait a sec. The oddity here is this is not telling us that it's plugin documentation is managed from the wiki. It looks like it might be getting documentation from your hub, because that's not wiki page documentation. Okay, so the wiki page has documentation. It's the plugin site is pulling from the read me, but no one bothered to bring in the read me in the best documentation into the read me. Right. Okay, so this bug report is a viable thing to do. Okay. So I'm willing to call that one a good first issue. This one, however, I'm not as sure of. Okay, the page proposed to migrate is the ping thread page, and it's already been been redirected. Yeah, so I think this one's already done. Except I don't know what pink thread is so I don't know why I'm entering ending up on monitoring Jenkins. Well and so let's let's cheat. Let's copy that link address we're going to cheat and bypass the redirect by inserting a few slashes. Nope, even that got redirected. Interesting. So here's what it's what it's documenting. Okay, so this was the content from the, from the wiki page. Okay. That makes sense but I don't know, well, I don't know. I'm wondering about leaving the ping thread page there. But, but saying something that this is used for monitoring and go over here for the information. Well but but when I click this ping thread page on the wiki. It always takes me to the monitoring page because ping the ping thread was used for monitoring. Or what could it take me to the ping thread part of the page. Yeah, that part the redirect could be updated to do that. That's that would be a another change. Yeah. I'm just saying, I'm looking for pink thread. And I see a page that says monitoring. And I think something's gone screwy. Well, and let's see if they've see I've, let's see if it's fixed it. Interesting. So now I can see it. That's funny. So yes, so there is some work to do because obviously, if, if the if, if Google search can find it, and you see it here, then the redirect process is not complete. Great. Okay, so there is some work to be done. Do you want to annotate is all of that mentioned in the issue or do you want to. I'm going to go ahead and annotate it now. So let's find that issue. So, got it. Okay. So, one form of the page was modified with a redirect. But if I use the dash form of the page. That's not redirected. All right, so let's get that updated. So this is pages page to migrate is now this one because the link that was there before pay and it's really page to redirect. It's no longer to migrate. And it should jump to this location. Yeah. And it doesn't need any terminology updates as far as I know, let me double check just to be sure. No mention of master no mention of slave. Other than in Java source code references. And those are not fixable yet. Okay, so we don't need any mention of terminology updates. And the two migration tutorial is. It really is just a update the update the redirect on the on this file. On the that redirect page. Wiki exporter no longer helps us. So fair enough. Yep. Good. And it's redirecting thread page from wiki to the dock site. Okay, so this one definitely is a good first issue we've updated it to be accurate. Now back to more good first issues. Azure DevOps and team foundation server. This is dead. The plugin is no longer distributed. Oh, because there are known vulnerabilities and it had a, there are three known vulnerabilities and it had an issue where we were concerned that it was had a non open source component in it. So this is a won't do it comment why. Right, exactly. So this was this. This plugin is suspended from distribution. To say that the distribution of this plugin is suspended due to open security issues. And an initial concern that it includes a component that is not open source. The source for the component was located. But no one has adopted the plugin. And no one has resolved the security issues. So close won't do. All right, thanks for your patience with that. You're okay if we keep doing this. Yeah. Okay, next one migrate the launching agent jar from console page. So this one doesn't have any useful information on it. It just needs a redirect. I mean, there's, there's nothing helpful there, right title and one hyperlink and a couple of pictures. And this picture is unhelpful. This picture is likewise unhelpful. And then this one. So, let's see. Okay, so this one page to redirect is that page and redirect destination. So this one. And then the using agents page or managing nodes I think was the word that used managing nodes here. Okay, this one describes what is the controller what are the nodes the agents how do you create an agents how do you launch an inbound agent, etc multiple videos I think this is a good choice for the destination. Everybody else. Right. And we don't need any additional. And I noted it here to him on shoe, asking about that that this just needs a redirect. Okay, next, migrate process tree killer this one I'm going to take out of good first issue, because after a conversation with a pro, he noted that he's not persuaded we really want to be documenting this technique. And it's already in process so it makes no sense to have it listed as a good first issue. Okay, my great unit test to developer docs. Again, this one is in process I believe, because we've got. Oh, no, no, it's not in process. Okay, the. No, it is okay. Here's the, the issue that's in process. Yes. Okay, so it this shouldn't be listed as a good first issue because it's already being worked on. And it's one of our long term legacy things that need to be migrated or need to be finished. Okay, migrate out of memory errors page to diagnosing build failures again this one has someone that's working on it. And it's got a poll request so it's not a good first issue either. Layout from multi day events dates overlap with time. Okay, so let's see if this one is in fact resolved. So DevOps world 2022 is a multi day event. And yet it's not showing up with any overlap. But it's also not showing more than one day. Yeah, well let's take a look at no that doesn't help. So what it used to say example of the layout for the mountain for the UI UX hack fast. Oh, okay notice here I see what he's saying this on the far right hand side may 25 through may 29 that is definitely fixed here as far as I can tell DevOps world 2022 is a multi day event, and it's. Maybe. Alright so needs needs investigation. I'm not sure I'm ready to put a needs investigation as a good first issue. Everybody okay if I take this one out of the list. Yep. Okay. All right now back to good first issues then we've only got four in the list. Now this is your chance to suggest others that you think might be good first issue. What about this one for instance. So his suggestion is, well, this one is a change to an area of the site that I would call complicated enough not to put it on somebody who is a first time contributor. So I'm not ready to put that one as a first good first issue. And it might be because it's really saying, let's describe it, and it says hey, these things are our environment variables, though again first time users may not know how to do that in pipeline right here. I'm not seeing any obvious things here. That would be good first time user things. I was muted and you were ignoring me. Oh sorry Meg go ahead. 5065 5065 sure right here. I'm wondering if Daniel put any that could be a simple writing thing if he put some information in it. Okay, good. So he partially addressed it with one poll request here. And my hunch was this one. I think I feel like that this is one Daniel will probably have to be the one who phrases it because he already did this phrasing. Right. And this improvement I thought was was very good it's what he's added is a why we announced learn why we announced this link to to these security advisories so hey when we say there's no fix for it. Learn why we tell you that. Right. But maybe sometimes, sometimes you put in need to say this and this and this and it just you need somebody to do the right and in this case, I don't think we got that. Yeah. Sorry. Okay. How about the installing Linux page has no where did it just go. This one installing Linux page has no upgrade guide instructions this one. So he could go up to asked if he could work on it. But that was back in April. And yeah, never joined and so I think what I'm going to do is take away the ownership there. Yeah, he's not working on it. Not that not that anybody else needs to and I don't think this one is a good first issue. Because you've got to know, you've got to know enough to understand how to do these upgrades on various operating systems. Okay. Need a category for good second issues. I mean, there's, there is stuff that somebody who knows a little bit could come in and do. And those, if you know if knowing a little bit is enough, you could do that, we could just call those good first issues. I think. Oh, oh, now here's one. Use the same navigation for dev docs as for the user handbook. I think this one is probably complicated. But wow, would it be a great thing thing to do. Just this one is not a simple matter of changing some HTML right this one really you have to go understand how the site is generated compare developer docs and user docs and make the change to the template files that would allow the one to act like the other. Right. So for me, I felt like this was probably not good first issue. Any of you disagree and say no mark, good, good first issues can be technically challenging. But what I'm Bob, we actually there's an issue is that it seems like October fast should have a place for people who want to come in and do something a little bit more. Maybe have a we don't have another way to flag. Um, you know something that's like, I don't know, can we add on October fast to label. Sure, absolutely that's maybe that's a good choice is it's not a good first issue but we could certainly call it October fast. But I know I'm like on another project that should remain lameness, but we've got a couple of people who are what they, they're not learning what they want is to post on social media. And they're sitting there every good first issue that pops up they're grabbing. I mean, six months I mean some of them done 30 of good first issues. Okay, you ought to be moving on now to other stuff, but there's no differentiation between a good first issue and something that requires somebody who's worked with the technology for 10 years. Right. Yes valid. Well so the Hector fest label is there and we can certainly put it there. Is part of it because sometimes things that are good like second issues might require a little bit more work. And people don't want to know, or don't know how much time they have so they mostly grab the first issues. But there's no way to find, to find stuff here that says if I've got the time because people coming in who's saying I, I want to do something other than little stuff I want to do a project that I can put on my resume. Right. And like I'm thinking the person who's doing all this wonderful stuff with the steps generator could probably grab this one. And there are people like that who like working with these tools have that sort of background so. Right. Yes, we can tell we mean we can tell them that these are, you know, now are they trying to earn points to get a free t shirt or something. Right. So we have to point them that this is a three pointer or something I don't know. Yeah, it requires changes. I'm going to just make a note it requires changes to the, to the templates that define the developer doc pages. Yeah. So that they will be more like the user doc pages, user handbook pages. Yeah. Well I know what the, but I'm also thinking some of the changes that your G soccer has been doing would be like the left margin and stuff like that could be ported over here too and that's a little easier but Yes, and I think that's part of the same same effort. The question is, use what we've learned in the user handbook side and apply it on the developer developer documentation. Right. And this is this is a good candidate but it's, it's not 30 minutes of work and you're done. Right. Can we market you do this you get your t shirt. Yeah, they require they require five PRs at least they always have actually, but that done correctly should not be one PR. Right. Precisely, that would, that's good point. This would probably require to do 10 PRs and not be done with this issue. This will likely require multiple pull request right. Right. Multiple pull requests before it is fully resolved. Yeah, good. Good point. That also fits with. Oh, we've got another one like that, which is not expressed as an issue here. That's a very good one make you have prompted an additional and let's look at, I'm going to show you a closed pull request. We created an issue to match this closed pull request we got to look back a little. There was a pull request that did a major rework of the look and feel. And the problem was, it was so dramatic that it broke a number of places on the site. And so what the counter proposal from Daniel Beck was hey, this is nice work but we can't have the site broken. Let's split this thing. He's wonderful. Yes, let's split this thing into pieces. And, and then do smaller commits with the pieces. Great. So let's see if I can find it. I think it was this may be me, the MEHDIBR. Nope, nope, I was wrong. Okay, closed pull requests. Just a minute. So it's closed. Okay, next page. Hey, it was before the blue ocean admonition. Maybe I should look for the word revert and it will give me a pointer to the thing that originally created it. There it is. Okay, this is the one. And what's what the one that made the change was this one. Okay, so let's link to that one with a new issue, new issue. And what it is is apply navbar header footer and layout improvements create a series of incremental pull request of pull requests that apply the changes from this one as a series of intentional, intentional, specific steps towards site improvement. Okay. Right, so the idea is that something should be a atomic self contained and clearly explained should be clearly explained for its purpose and understood and its impact should be understood. The problem was this, the, the, this pull request was just too big and change too many things at one time. Okay. Is this a reasonable to everybody as a description. Yes. And that's a good first issue then right. I don't know which see the challenge for me is then you've got to you've got to take it. Yeah, this one might be a very good hacktoberfest topic. But it's, it's not. Someone will need to read that original pull request and extract things one at a time piecewise. Right. It's, it's more much more involved than just write some HTML, right, write some JavaScript in this case or some CSS. But for somebody who's looking for something to start with a little bit of knowledge and build their skills that would be an excellent project. Yes, right. Precisely. Good. Very good. All right. So onward to next page. Back back back. Oh, I missed something. Almost at the bottom. I saw something. It can only read on the next 4724. Yes. And one for me is not a good first issue, because it really requires that you know how to do these steps and be able to describe them right now what the this this tutorial is just too weak in terms of what the requirements are for its preconditions. We must have installed enough plugins that you can see the right things, but it doesn't list the plugins you need it then assumes Docker. But of course we never told you in advance that you need to install Docker and how you install it, etc. So it's, but a lot of that information is available elsewhere in the dock it's just not in the tutorial. It's, it's not in this tutorial that's correct. Yeah. Okay, maybe not good for station for a writer. Who could buy research go back in and read the actual pipeline documentation. You know, and again because I would see this as not a single PR. Right. Okay. I don't want to review that PR it would be one of those things that would take off my life. This will need multiple pull requests using reusing reusing the existing Docker tutorial instructions for setup. Yeah, so, so there's, there's a lot to be done there. So while they're working for here it's a T shirt and a bit of glory right. That's correct. I'm wondering if it's good. One of the things that bugs me about GSOC I mean for very good reason because there's real money involved. We can't ever do teams. And the idea to work together with a team to collaborate is one of the great joys and strengths of open source. And that other one is something we're like two or three people who are interested in it could work on it together. Each other's PRs could help each other learn. I don't know if that's possibility but Yeah, that's a team might choose to self organize and and take this on I think, given that this will require multiple pull requests I think that's feasible. I don't know who you would find to mentor that because you'd probably need somebody to say, Hey, I'm willing to coach you as you do it. Right. Unless, but I think, looking at that like you said, there's a lot of improvements that I mean just as I say, here's Docker, there's nothing in there up front about Docker. Right. There's other instructions about pipelines. There's videos with I think with some research, and it would, it would be a great learning experience to pick off individual pieces of it. You a bunch of little PRs. We don't have to put it, you know, could just put that as we're and I don't think we want to get in the business of organizing these teams either. But when we're announcing October Fest, we could point out a couple of these that, you know, you might want to get a team for. Good. Yeah, good idea. So okay if we continue Meg. Yeah what's using latest stock search is that that's a that's a relatively special one that relevant. Yeah, oh it's very much still relevant. Okay, so they've been improvement on the Yeah, so what's what's happened is the search results have the quality of the search results have decreased. And they've decreased because we're using an old, older crawler for our content crawling and I was upgraded but we haven't made the changes to upgrade it. Okay. And this one is really one that it's probably got to be done by either Gavin Morgan or me, because I think it requires permissions on the Algolia doc search site. Unless you got somebody who's worked with Algolia elsewhere or something. Well and even then they would have to have permissions to the Jenkins portion of the Algolia search site. And somebody I mean, it isn't that for heck they couldn't go in there and say oh, I love working with Algolia. You, it's, this is not exclude this is the, these are things to help them find stuff but they can go through and pull out something else right and apply. They can grab an issue that isn't marked for good first issue or have to over fast. They certainly can. Absolutely. The challenges in this case they would have to be granted permissions to a portion of the Algolia site that they probably don't have currently. Right. Yeah. Okay I'll shut up go on. No great. That was not what I wanted this. All right so ready to try page two. Okay, Meg, any of these that you've got assigned to you and I think that's because you've got changes in progress for them right. Oh that that is, I think that's my big massive. Right, which. So that's it's in progress. Right but I'm starting to wonder if that's ever going to happen. Getting older and older and crustier and crustier. We certainly should not close those issues until we get it open until we either get it resolved to give up hope. Right. Yeah, this. Yeah this one this one I'm actually prone just to say, we're not going to do this one. So, okay Gavin had a suggestion, we could update say hey for most current information see, see the pipeline syntax snippet generator. Yeah. So this one is probably a good first issue then it's that's not a hard thing to do. Right. This is preserved here for historical interest and for current right exactly. I'm going to put a thumbs up on that. Good. Broke links to anchors is that that one is a Daniel Beck report, and I don't know that. Yeah I don't think that this one is well suited. If you look at 40 to 40 this one is from April of 2021. So but is bug fix so yes I guess it could. It could certainly be a hacktoberfest topic. Yeah, a co change needed here somehow on on the ruby code that's being used. So make you this one is you want a hacktoberfest link on it I'm not ready to put a first good first issue on it. Yeah, October. Yeah, that sounds reasonable. Okay. And we are three minutes away from my needing to stop so that I can get some sleep. Other other topics before we call this one done. I want one minute after you stop the recording. Oh, okay, we're good. So I propose to stop the recording now then I think we've made some good progress. Yes. Okay. Okay. Stop the recording.