Jenkins Documentation Office Hours, 17 Sep 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 2020 09 17 GSoD Office Hours

Description

Jenkins office hours for Google Season of Docs September 17, 2020

A

Cloud, okay, so welcome everyone. This is google season of docs office hours for september 17th.

A

Thanks very much uh and xena: do you want to take us through the agenda.

B

B

Okay, so um I started working on documentation on installing jenkins on cuban letters.

B

So um probably if it is possible for us to review that today and discuss about it, I also um configured um katakuda and installed helm, so I've been reading on those um tools- I'm hoping I was thinking- would have the session would have had the session with maki, but since we're unable to have that, I think I'll just um save my questions today when we have the knowledge sharing session.

B

um What else did you do.

A

B

Now I'll share the link to I started working. The draft of the documentation is in google docs, so I'll share the link now.

C

B

um So for this I'm still going to make a couple of changes to the.

A

Documentation and and this this looks like a great start- thank you for drafting it. It looks this looks exceptional, so the idea is that reviewers, like me and kristen and marky, could make comments in the google doc as you're revolving. It quickly.

B

Exactly before, I'm opening a pull request on jenkins dot, io.

A

Great this, this looks wonderful, kristen. Are you? Okay with that that review technique.

D

A

Go ahead, zeno! Sorry, I didn't mean to interrupt you.

B

Okay, um also, I wanted to mention something else: okay, yes, um for the structure of the documentation, as discussed in the last meeting, I'm not done with that, but I I started working on something I'm going to share with you. Also that's how we intend to merge um jenkins on kubernetes documentation, with existing documentation on jenkins, dot.

B

A

So- and this is based on uh notes from previous meetings and now you're refining and improving that giving getting more ideas there.

B

So, oh no sorry, I think this is wrong. This is a proposal.

A

B

No one is just the structure.

A

Yeah yeah, this looks like the original proposal right.

B

Yeah, I have a document with just the structure.

B

Here so we don't have to scroll through the whole.

E

B

B

Okay, so I shared the link.

A

Excellent thank.

A

You and it is here, okay, very good. Let me link into.

A

B

Very good: okay go ahead; okay, um so scroll to the last page.

B

Okay yeah. So um since I'm working on installing jenkins on kubernetes, I have not updated the latter part of a work on this, but for installing jenkins on kubernetes, I don't know I propose putting it on the installing jenkins. So I notice there are different platforms.

B

B

So I don't know if this works or if it would be better somewhere else.

A

For me, this works great, I think that's very reasonable.

A

That means people who want to install jenkins will find find links in to all the installation instructions in this one document, so that that seems very reasonably I might I might put kubernetes, I wonder, should it be below war file, but really you know it's probably more popular to do on kubernetes anymore, becoming more popular than using a war file. So that's great, where you put it.

F

Right, especially if docker is that high up, it makes sense to have kubernetes.

A

Right right, I suspect kubernetes is at the moment you may be marginally less popular than document documents, probably rapidly overtaking so.

F

Yeah yeah. I can see that because, if you're, using docker as kind of a test environment- or you just want to spin something up quickly like it's a preview and then eventually move to doing it more formally in your cooper, you know experimentation. I guess like that would be.

A

Right right, using it using docker for preview environments or test environments or we've got ci.jenkins.io that runs a docker image of jenkins, just in docker no kubernetes and and that's one step on our direction towards kubernetes. Eventually we're seeing jenkins.

A

So this this looks great to me: xeno thanks very much.

B

Okay, so um I'll keep updating this. This um is current content for jenkins.io, so I'll keep updating this templates here with the new content for jenkins on kubernetes. So if, at any point we need to create a new volume, probably the content I want to document does not really relate to anything that is already existing.

B

Then that's when I'll create a new volume, but for now just keep updating.

A

Great and so when you say new volume, for instance, that would mean something if you find you need to create something at the top level here.

B

A

All right that that looks exceptional, very, very good anything else. You want to review on on that document, structure proposal.

A

All um so really see the proposal for the insertion points.

A

Great excellent, thank you. Thank you.

A

A

A

There we go okay, great.

A

Our next topic we had on the list was knowledge sharing sessions. I apologize that marky was not feeling well, but he has mark. He joined us.

A

Not yet, okay, he had a meeting that he said was running late, and so there was a chance he he may be still late yet to join us.

A

The proposal was to have the session to shift the session that we had planned for yesterday to be during monday's office hours session. So this time monday is that okay for using up.

B

Yes, that's fine.

A

Okay, all right and and mark he had suggested he would like to do helm and katakota at that time um and that felt good to me and then, if we want to have torsten walter, do an additional session on katakura on helm. That can also happen later.

B

Yes, that sounds.

D

A

A

A

So anything else on the knowledge sharing sessions.

B

um No, nothing else.

A

Okay and in your I guess I have a question that I didn't put on the agenda. Let me put it up here: is cluster access, so did? Were you able to use mini cube like we had hoped.

B

Yes, yes, I was able to use mini cube.

A

Excellent. Okay, so you you, don't you aren't at a point where we have to do a cloud hosted thing yet. So that's that's great!.

A

Very good, thank you all right. I had one item: updating the google season of docs documentation, page on jenkins.io. I've submitted that pull request. I would love to have reviews of it. I'm sure oleg will be one of the reviewers of it right. I'm hopeful.

A

I think I've made things accurate and move things around just a little bit without being too terribly disruptive. If you find something that I've made a mistake on by all means tell me write in the poll request.

B

Okay and then also um I wanted to ask a question about the last two requests. I made that's um making changes to the layout. The layout I like raised something in the last year.

A

Okay, should we go look at that? Let's go read the comments. Let's see.

D

A

Menu in just a minute, so, let's okay, so we need the closed pr's.

A

Author, oh no, that's interesting! Oh finish, my typing.

A

Okay, so was it the ad jenkins? Okay? So let's look at this one and let's make the text big enough to read okay, so the concern was oh yeah and you, okay,.

A

Okay, so so is your question: how do you do that.

B

Oh yes, how do I do this.

A

Okay, so let's take a look at that and what I think you would do is this is this: is a hamel, a ruby derivative indentation based markup language that represents html by using indentation, as as the way of in hinting at what the structure of the document is, and so what we would need to do is you need to take?

A

Let's see, let's find the place, there should be a google project.

A

Yeah so projects, and if we look there, okay, jenkins area, meetups.

A

ah ah Yes, okay, got it all right, so what this does now?

A

Is it iterates over the list of projects in the in the directory structure and places those into the subprojects, and I think what we would we could take a simple approach and say: after doing all that, iteration we copy copy something that looks like where is it looks like.

A

Well, for instance like this, these two lines right after this entry here, so that in the drop down menu, there would be a new row added with a percent. A dot item feature: oh no, no sorry, it would be one level deeper and it would be one of these.

A

That so let let me bring it up just to be sure that I'm I'm not giving bad bad guidance, but I think what we want is we want to add something to the end of this list.

A

At least that's my proposal is either yeah because overview is at the top. It's going to iterate the list, and so we then put let's see if I can see double check, is.

A

Overview, oh yes, okay, so you could. You could also put it above the list if you were to insert it between lines, 101 and 102., that would that would also work, but it's the my mental model is either we put it above the top of the list or at the end of the list, and what you do is insert.

A

An entry there which says so if we look yeah, if we we want something, that's sort of like wiki or issue tracker. So if we look at how issue tracker is done, it would be these two lines oops. It would help if I could copy those two lines you could replicate here to either line after line 100 or after line 105 and put the correct text in them for where it's supposed to link.

B

Okay, so um my question would be like for the other drop down menus like community plugins in in the code. That's on github.

B

Like in the pull request on.

A

B

Not sure I'm understanding your question.

A

B

Yeah, that's the question from here, so I can see that for this other drop down items they are actually explicitly defined, say for mailing lists up for accounts, yeah, exactly they are defined, but in sub projects we don't have like under the sub projects. We don't have all this um yeah exactly.

A

Right, right and and that's you're, exactly correct what you're, seeing here in in subprojects is this dash character? That starts the line, I believe says we're now going to do ruby code at this location.

A

Oh, this is actually ruby. That's in line inside the page. So when the page is generated by the ruby, the ruby page generator, it will be turned into a static page, but it actually executes this ruby, ruby code and the nested dash gives us another a a kirby, brace section of ruby code that is then executed as well.

A

So if I, if I understand correctly the way hamel works, this leading dash means this is literal ruby code and then percent a percent a says. This is html code or becomes html code.

B

B

Okay, I think I that's clearer so I'll just add another option. That's after line 105 for um jenkins on kubernetes.

A

Well or yeah she said and did we decide it was, I think we did decide. It was jenkins on kubernetes.

B

A

Okay, great, very good, so so you're. I apologize that this is this. Is this shows a bent towards programming and programmatically generated sites, and I apologize for that, but it makes the the site much more consistent because we use this programmatic technique.

B

Okay, okay, that's fine, then thank.

C

A

All right, so let me make a note of that. So I have discussed how um ruby is used, ruby and hamill and used generate the pages.

A

Got it okay, so you're you're? Okay, with that description,.

B

A

Okay, great and if you, if you have question you're, welcome to ask me in getter chat um in the docs getter chat, there are others there who are also familiar with haml. So there should be several of us available who can help with it.

B

A

All right, any any other questions that you had or any other topics we need to bring up today.

A

Oh well, hey marky, since you're! Here! um That's, that's wonderful! Are you at a spot where you want to do some already get started on the monday office hours, topics of katakura and hell? I think we've largely completed the agenda topics we had with zenob and if you'd, like we've got time xenon, do you still have time that you could stay for another as much as 30 minutes.

C

E

Unfortunately, I don't we'll have to move that to month leave that for months, okay, but monday,.

A

E

Session ready to do for both of those excellent okay.

A

So we are set for monday, then that's perfect all right! Well then anything else nina marky or kristen.

E

Nothing from me.

D

Nope, nothing from me.

A

All right, I think I think we can call our session done for today. Then xenom, congratulations, marky! Had you seen this, this marvelous work here so project pro. Let's see here, we go, zenob has started, creating the documentation she's now five or six pages into a google doc. Wait looking for feedback from from mentors on the content before she submits it as a pull request. She's got a proposal for the structure here, including where to insert the kubernetes, install and and she's looking at having.

A

We did a review of hamel of how to do the uh how to do the insertion of the entry into the menu.

E

I will go over that doc today and have my feedback shortly. Oh excellent, thank you.

A

All right, well xena thanks very much I'm going to go ahead and end the meeting then.

E

A

Thanks everyone: okay! Thank you. Thank you. All.