Jenkins Documentation Office Hours, 7 Sep 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 2020 09 07 GSoD Office Hours

Description

Google Season of Docs office hours for the Jenkins project. This is a community bonding session from Sep 7, 2020 that includes Zainab Abubakar and Mark Waite discussing plans for next week's start of writing.

Meeting notes are kept at https://docs.google.com/document/d/17cPLUrJ4Ul4Y8MREjDyfWBEN7PlnlrmPh6wuKMPFmPg/edit#

A

It's now on and I'm going to share my screen so that we've got visual to the notes for the screen.

A

Yeah here we go. Can you see my screen.

B

A

Excellent, okay, all right so xenop. What topics would you like to put on the.

B

Agenda, sorry, um okay, so um I would like us to talk about um the structure of the um kubernetes volumes. We are going to be creating. So what are the content that is going to be in this volume? Because we've been talking about a lot, we talked about hem charts, jenkins, plug-in kubernetes plug-in.

B

So um I think I would like if we can streamline it to um actually point out the topics or the contents that we want to cover in the documentation say, for instance, installing um jenkins on kubernetes, um like what are the content that we want this william to have.

B

I like us to discuss that then also um I was hoping thurston would be able to join this school, but since he's not maybe in the next meeting, I also like us to agree like maybe when it should be convenient for us to meet.

B

So um we can have the knowledge sharing session and we talked about.

A

Yeah, so that's good! So that's that was what I think of as the helm chart overview meetup and the katakota meetup.

A

Were there others? In addition, so let's, let's call maybe we should call those two knowledge sharing sessions.

B

Yes, it would be nice to, you know, point out all the sections we need to have, so we can know how to set the schedule um discussions, so we can start working on the documentation, then also um the plan. I think it would be nice to review the plan and the timelines I created during the application phase. So we can see if we need to make any adjustments.

B

A

Yes- and I think not just reviewing but reviewing and refining uh timeline, um the project timeline yeah, so we can use the the project proposal is a great start, but certainly it needs more detail and more more more safety checks. If you will more checks that okay. Does this express what we need, because I think you had a very, very good idea right here in the structure of kubernetes on jenkins.

A

How should that section be structured and that will significantly affect what should the project timeline be, and what should we work on first etc? Exactly.

B

B

Okay, what else um also I I've been going through the um links that mikey jackson sent on katakurda.

B

And and so far I think I'm good, I understand the concept and it would be nice to create um something, a scenario for jenkins on kubernetes, using this.

B

Maybe something about installing jenkins on kubernetes.

A

So could, could you give me a brief overview? It's a it's, a tr, I'm used to it as a training system.

B

Yes, exactly it's like yeah, it's like a training system. It takes you um through um practical steps. It gives you like a playground to practice, maybe like um say installing kubernetes. So it takes you through the black practical steps of um carrying out that process. That's what it's like so um say. For instance, if you were to put um jenkins something on jenkins on kubernetes, it should be like a guide that will take um users on how to install jenkins on kubernetes and actually give them a playground to practice these commands.

B

So it's very practical.

A

So it it to the student it feels as though they have access to a kubernetes cluster and they can exactly nice. Okay,.

B

A

A

And now is there a is there a cost to that? Is there some some some price that they're going to charge you for oh you've used this, or are you allowed to use it for free, initially.

B

um Yeah, so actually I'm creating a repository on my account and I've not released I've not seen anything on um pricing yet so I'm trying to go through the whole process. What, if anything, if I notice anything on price and I'll communicate with the mentors.

A

Great all right, excellent.

A

That's that's very encouraging. You know.

B

um So also, I opened a pull request for the project page on github. um I like dropped a comment about the layout, I'm trying to resolve that, but I'm not really sure how to so. He mentioned that I might need to use gsoc layout or use a generic project layout.

A

Yes, so so so this may be it so jenkins.io as a site has the concept of layouts and and they are defined structures for subsections of the site and and there isn't. What he's saying here is there isn't one for the google season of dogs?

A

But there is, there is one for google summer of code, and so we could try using the one with google summer of code as an experiment, or we could use instead of gson project. You could just use the layout project and then then see how that feels to you. So, let's see we could look at. We could probably look at examples.

A

Yeah, I'm not sure I've got well, we could check to see. Maybe I do have examples here. Let's look.

A

So if we look at, I think it's in content data and I would bet that no.

A

ah There, it is, it's content underscore layouts, so the allowed layouts are in content, underscore layouts and here's the google summer of code page layout- and here is the project layout. You could conceivably say. Oh, I think I think we need a separate google season of docs and you could then create this page in the layouts folder here, so that you could have a google season of the google summer season of docs layout um and and then it's just a matter of okay. Is this the layout that you want and if so, yes, you could?

A

You could derive from that layout.

A

Now I had I had looked at project layout. Let's see how it looks it.

A

A

Yeah project looks pretty simple, so it it. You could also consider using project. But here are these are some. These are some choices that you have for page layouts, that you could you could reference there.

C

A

Now I I don't was that at all helpful for me to navigate around like that.

B

A

B

Yes, thank you.

B

Okay, oh I'll, go through the layouts and see if I can use an existing layout or if I need to create a new one. Okay,.

A

And now now, as a, I assume that you're using a uh let's see, let me I assume that you're using the make run command so that you can see how the page looks.

C

A

Okay, because if I do a hub pr checkout and look at your pr, which is 3686.

A

And I will try to do some review of your of your pull requests today or tomorrow.

B

D

E

Okay and now, if we look at localhost.

A

There we go okay, and this was the page you were creating was.

A

Google summer google season of docs okay, so.

B

D

Interesting, okay, how would I locate it? Oh maybe.

A

B

A

B

I think I actually wanted to say something about this, also because I noticed that when I wanted to navigate to um the google season of dogs project page, I had to go and get the links from um google season of docs websites.

B

I couldn't find somewhere to navigate to it from right.

A

Right, which is probably a good reason for us to so you you see here that we've got navigation for subprojects, so google summer of code has one, but we don't have a google season of docs navigation, and we would also want it to be linked into the documentation page here so that we could find it, but I think I think it should be part of the top level navigation also.

A

So so absolutely so, this page is the intro page, but I would think this page should be linked into the navigation somehow and then your your content could be added, for instance, right here with links to this new page that you're creating so document jenkins on kubernetes. Let me see if I can get to it, so that is gsa. 2020 projects.

A

Oh, oh here we go doc. Oh, oh, very good! Oh no! Okay! So that, oh, oh, that is it okay, but it ah yes, okay- and this is this- is the reminder to us that what oleg was saying was was crucial.

B

A

This is what happens because there's no project and it's referencing, a non-existent no layout, it's referencing a non-existent layout, and so it's it's doing a completely unstyled page. That's cool, okay, good! So it is linked there. The the project is linked. That's a good sign, but um I think you're right that we need something here in the navigation.

A

I would think we would want it as a subproject.

B

So um would it do norm be, would it be to move the content um from the current directory to the subproject directory or create a an entirely new page.

A

um So I would think now, I'm I'm not I'm certainly not definitive. I have to think hard about these kind of things and sometimes I make mistakes, but I would think, uh let's see so, let's make some notes here into the mark- recommends. um Add google season of docs to the subprojects menu.

A

Below google, or up actually above because it's alphabetically above above google summer of code and have that link.

A

See that should probably link to the wouldn't. We want it to link to the google season of dogs.

A

A

D

Need to get a real link.

D

Let's see so documentation.

A

Sig google season of docs this page, I would think the the page that it's going to open here. This page should be the one that's linked from the subprojects and we would put your project above the project ideas right because for me, a real project is much more valuable than a project idea, and so this section down here where oh, let's see where you would add projects, I would put it actually up yeah, so you've added it here.

A

I would be much less shy and I would put it at the very very top right below this paragraph. So that way it's immediately grabs them. Oh, we had all these ideas, but here's the one we accepted it's the top.

B

D

All right so now, let's.

D

Let me get that page embedded.

E

A

Okay, good all right and then move the projects paragraph, the top of or to near the top.

A

A

Because it this is, it's certainly more more important for readers than the ideas. The ideas are great, but we've got one that we're working.

E

A

Now is that still now now, back to your question, I think you were asking: are there other places? We should put navigation to google season of docs right, so we've got the documentation page here. We could consider, for instance, moving google season of docs up to the very top, because it's our current focus.

A

So on this page it seems like where we've got a list of projects and these these projects have been going on. But why not move jenkins on kubernetes right to the very top of that.

E

A

Yeah, and is this a place where do you think cnab? You would be willing to put put so here's a topic and could we put your project as the topmost link now here to say, look documenting jenkins on kubernetes, because we're going to work on this for the next three and a half months.

D

B

A

That's another one to consider at least now I don't. These could be separate, pull requests. You don't have to bundle them all into the same, pull requests. You know.

B

A

These are, and, and all of these you should consider optional right, and this is just me offering ideas so add jenkins,.

D

Title project the docs.

D

A

Project section, because I think I think that will help people find it more readily.

A

Very good any other question on that on the pull request.

B

A

One more note here, because I didn't make a note of this- it was something about.

A

Review the layout and choose either create a new one or choose one that or choose existing.

B

Great okay, so my next question is about the introductory blog post.

B

Okay, so I feel like there's so many content around um introduction to the projects like the project page, then um this blog post is it going to um my question rather is around the contents of the blog post, because I remember you mentioned something about um me: writing about chico africa.

B

So I'm trying to like figure out what um this blog post is going to be centered on.

A

ah Good question, and- and I'm I'm, I think, we're open to whatever. Whatever you would like to write about. My thought had been that that kubernetes jenkins on kubernetes is, is a is a really cool thing to introduce, introduce.

B

A

And uh invite others to help right. Invite others to this. Is that that's that's a that's that, for me, was the sort of a headline. Is look. Here's what we're doing, and now I think you had done something like that for cdf.

E

A

I'm not finding it immediately, but you haven't.

B

E

A

No okay, so I'm not I'm not finding it, but I can link to it later. I'm sure it's there. Okay.

B

Yeah my experience contributing to jenkins.

A

Right so so my thought was okay. You could note hey jenkins on kubernetes, and this is what we're introducing. uh You could probably give a summary of summarize the timeline right, hey we're going to we're in the community bonding phase now and so we're in the getting ready mode.

A

We start writing um official writing starts. I think it's september, it went no noise. Is it maybe it's october, I don't remember the timeline, but let's let me grab it real quickly.

A

So we start oh except so we are one week away so yeah so good so september.

A

14., so we've got one more week of community bonding and then we start the actual writing and that lasts for for three months and we're looking forward to to working.

E

A

And then I assume links to the project pages.

A

Etc does does xeno, does that make sense to you and is that okay.

B

Yes, it does yes.

A

I mean I'm I'm personally fascinated by she codes africa, but, as I think about it, I'm not sure how I would put chico def. She coats africa into this.

B

Exactly that was that was my confusion, because I was trying to figure out how to piece in information on chico, africa and information on jenkins. In the same article.

A

Right and- and I think you're right that doesn't that's- that's not a logical there's, not a logical connection between them, so yeah you're, absolutely right! I shouldn't have shouldn't, have mentioned something so peripheral to the the key objective of jenkins on.

E

A

Great any other question on the blog.

B

um No, that's all.

A

Now, access to the kubernetes cluster, I've asked for donation from a cloud provider um and that I've been involved with just recently, and I will ask for donations from others.

A

Have you used already the microsoft azure three hundred dollars, credit.

B

A

Okay, so that might be a way for you to get cluster access for at least a month. um That's now! Certainly if you, if mini cube, can if you use mini, cube and local, that's that's the best, because then you don't have to bother with cloud or internet access. You can do it entirely on your own computer.

A

And I think who actually wasn't this one, that we had agreed on a knowledge transfer that marky mentioned that there were other techniques like mini cube. That would let you run locally. That might be worth us a discussion and a knowledge transfer, another sharing session to say, hey, here's.

B

I'm this I didn't get that.

A

I think I think that uh marky jackson mentioned other.

A

Alternatives for local kubernetes cluster access and a knowledge sharing session might be a good to review and discuss because as you're as you're presenting to as you're thinking of how people will use this. Knowing that there are multiple ways to access, a cluster may be very.

B

A

So let me let me take the action item to look for times when we could do those knowledge sharing sessions.

A

Does a doodle invitation work for you as a way we've used that in the past.

D

A

Great okay, so I will I will send those proposals for a helm, chart session and katakota for sure.

C

A

And then, if, if in thursday's session with marky, if mark is able to say oh yes, here, let's talk about these other alternatives. We could schedule a session for that as well.

A

Okay, now you had asked the question about the structure of the kubernetes on jenkins section in the documentation. I'm a little concerned that I'm not the best expert to give coaching on that. Do you want to offer some of the ideas you had that I could note into this document and then and then we can review them on thursday, with others other mentors. How would you like to do that.

B

Because I myself, I'm not really sure if I'm going to mention contents, most of what I'm going to mention is going to be um the content I have in my proposal.

B

Yeah everything I'm going to mention is going to be from the proposal. I created the proposed structure, so I think it would be great if we have the other mentors around. So we can all look at the content in the proposal and see which ones are okay or what needs to be updated.

A

Great, so what we would do is review the proposal in next session. uh Refine and update. Is that a fair way to say it.

A

Let me put a link to your proposal here so.

A

D

I think we've got that right.

E

D

That one ah yes, this one, this.

A

One ah yes, this is the one I wanted to link to.

A

So if you're, okay with that, could we walk through that? Just to help me remember one one more: it is here: we've got.

A

Okay jenkins documentation on jenkins on kubernetes, and I think that so introductory section what is kubernetes.

B

And then I think you can go down to the last page. It's outlines just the content.

A

ah Oh very good, excellent. Here we go okay. Thank you.

A

Perfect, because that.

E

A

So getting started.

A

Docker images using a jenkins file.

A

Okay, then alternative cloud providers.

E

A

So this this looks like a great thing for us to discuss with the other mentors next next session. Yeah.

B

Because it would be nice to have like escalating of what the new kubernetes volume is going to look like, even if we don't have the content yet so we can be updating. The skeleton as time goes on with content.

A

Right right absolutely well, and- and there are things things that I would assume- we would want here like how to use the kubernetes plug-in, and what does it mean to use a I've heard the term sidecar image a? How do you using docker well with with the kubernetes agents and those kinds of things that I assume would be good to capture here?

A

B

E

E

A

Let's see, and there are I would assume we will want something about helm, charts and I guess that's probably part of installing.

A

Now one, that is a perplexity for me, is making windows using windows in kubernetes.

A

And and agents- I I think, is the the crucial one where it's docker images for windows, uh building for windows.

D

D

A

Any any other areas there that we should discuss on structure while we're while we're getting ready for thursday's meeting with the other mentors.

B

B

I think that's.

A

All all right- and I have this action item to.

E

E

A

Any other topics that you feel like we need to discuss today.

B

No, I think, that's all from.

A

And I don't see any other topics either great.

A

All right so so I think we it might help us if you and I both spent some further time gathering ideas for the structure of the kubernetes on jenkins section that okay, that way, the other mentors have can look at the ideas and say no, that's a poor choice or oh, yes, that's a good one. It should be prioritized this over that.

A

The the thought for me was: if we give them ideas, they can tell us. Oh no, that's a bad idea much more readily than if we take make them generate the ideas.

B

E

E

A

Okay, that's all that I had then xenapp anything else from you.

B

Okay, um oh, I thought you wanted us to work on more ideas for the structure.

A

Yes, but I was assuming we would do that independently, so that you don't have to be stuck on a phone call. uh That way you can, you can think about it separately and we'll we'll just let let you think about it I'll think about it, we'll make some notes in this document and and then then, when we get to thursday, we can use those notes to help in the discussion with the other mentors.

B

Okay, that sounds great.

A

All right, I think we're set then thank you very much thanks and I apologize for the the slow start today. Thank you very much for the reminder and we will plan to meet. Let's see our next session will be.

A

D

It will be the 10th.

A

Okay and I will post a copy of the uh or I will post a link to the recording of this session so that we've got a recording of it and I'll put the recording hyperlink right on this document so that you can find it. If you need to see the recording again.

A

All right, thanks, cdub.

D

Thank you enjoy the rest of.

C

Your day, bye, bye.

B