keptn Keptn Documentation Office Hours, 11 May 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Keptn Documentation Office Hours - May 11, 2023

Description

Meeting notes: https://docs.google.com/document/d/156pqw4r_O6O7O-YDm9DfuuBUS3GvAXmvjjDyFEpbwUY/edit

Learn more: https://keptn.sh Get started with tutorials: https://tutorials.keptn.sh Join us in Slack: https://slack.keptn.sh Star us on Github: https://github.com/keptn/keptn Follow us on Twitter: https://twitter.com/keptnProject Sign up to our newsletter: https://bit.ly/KeptnNews

A

B

A

I'm sorry I didn't realize: I was sitting here muted, it's.

B

A

Good, how are you how.

C

About you, I.

A

Miss that guy see nobody was here and I started. Looking at something else and my mind just wandered.

B

Yeah Adam's um sorry I was gonna just on camera, Adam's gonna be traveling, I think he was in uh Canada he's.

A

In Vancouver, yeah I talked to him last night.

B

A

Forgot to ask him about this yeah so he's on my time zone. So it's 10.

C

B

A

So that's why I said I forgot.

B

A

To you about this, we were talking about other things, but that's okay.

B

I was talking to um a guy from the lynx Foundation his name's Knight. um He hosts tick, tocks and and Tech writers, office hours for cncf and I told him. You would probably be interested in it as well. Yeah.

A

I almost wonder if we should merge I, don't know how much I mean we're getting almost nobody coming to this once I guess we're conflicting with Indian um university schedules.

B

Well, the problem with India is they're very strict on lunch hours and- and you can't exactly pop away from your desk to do these meetings right, they're, more strict- and um you know over here, for example- yeah. They don't work from home as well, where I can work from home and just jump on these schools right right, so Maybe.

B

Maybe we can ask the young students in there at the moment. You know what maybe try and get them to somewhat run it as well, and then they might get a bit of uplift and if we enable them, they might really take ownership of it and just bring all their friends. And you.

A

Know yeah yeah there's that.

B

Because they're, the ones on Twitter and all those you know whatever that Masters on and all that is yeah.

A

B

Don't really care about so um I guess yeah. We can ask them to sort of help the Outreach of it as well.

A

Great figure out.

B

A

B

Yeah so yeah, it's a shame that Adam can't come as well.

A

Yeah but we'll just have to do this again, sometime.

B

A

God and I I got our agenda, pulled a different computer. You could see it, but let's share it here or is it? Where is it? Where is it now? That's Captain, community, oh hey!

A

You need to get organized there. We, when all else fails go to the bookmark okay.

A

So how's everything going with you by the way.

B

Yeah things are going good, um just yeah I'm doing I'm working on the kubernetes release team um is the comms lead, so that will take a lot of my time up to the next three months. Oh.

A

It should be pretty good yeah.

B

And um I'm working on the get up, get UPS exam as well. So that's another thing that will keep me busy and.

A

B

So so pretty busy at the moment, but looking for the the other Captain meeting, doesn't it conflicts now because I have to put my daughter to bed at that time because of the daylight saving? We don't have daylight saving here. So the time is I can't go to that meeting anymore. At.

A

The moment no, no, which one is that you can't go to the community meeting yeah.

B

The APAC EU one okay, uh you probably haven't seen me there for a while, because it's.

A

Not because I don't want to go yeah.

A

C

A

A lot of community participation in that either.

A

C

Don't know actually we're talking huh mostly it's.

A

Giovanni and the core team that report to Giovanni and me and Simon, but.

B

Do you they have the developer one instead right, there's a.

A

B

A

B

A

Developer one quite a while ago,.

C

um What we also.

A

Have one that's interesting now there's a refinement meeting on. Oh.

B

A

Oh, what day, um everyone might interest you, because that's they're going through issues that they're going to work on in the near future. So that might be. Let me send you I! Think it's for me. That's early Tuesday morning, I think.

B

A

Love this I I, don't know what I don't know what today and tomorrow mean anymore I'm totally baffled. It's really fun when I actually have a live appointment here, trying to figure out when I go so um but yeah we need to I mean that's something we need to and I don't know where we address it. If it's, it almost sounds like it should be. Governance board, except I, think the issues might be better dealt with by technical or something.

B

A

And I were talking, I mean I, think we're doing some stuff that are putting up some barriers to community people participating, probably.

B

Yeah I can help Outreach it and.

A

B

Should have we should I was hoping I tried to bring up some process stuff at the technical steering committee last night to not just talk about technical, but how we can you know, improve our process, get more technical stuff done if.

C

That makes sense so things like.

B

This wouldn't be important, uh yeah I'm, not sure if it's the governments, but anyway we can is um uh hi. Yes, sorry, um how are you I'm good.

A

C

B

Can't I can't get br's.

A

B

Someone someone just joined.

A

He's working on getting this mess of stuff we've got for contribution, organized in some same fashion; okay,.

C

Have you met Brad before.

A

Brad's one of the members of the technical community very esteemed and super nice though, and I know amisha's in class.

B

A

Yeah and Simon's going to join us in a couple of minutes. He had to take drop the kids at kindergarten and then he'll be here so yeah.

B

I've got to do the opposite, so I've got to go pick my daughter up pretty soon, because she has uh swimming lessons. Okay,.

A

So, let's get to this so quickly, I! This is I put down what I thought the principles were just to save time. We can any of this can be deleted, but my understanding is that our priority is we're is to get some stuff for people. We go to these conferences and people get all excited about Captain and they they docs need. They need to come in and find something that's ready for them to take them in the next step. So I'm on you know, um tiger team to get some getting started guides out there.

A

um My opinion, not necessarily shared by anybody else, but is that they I mean I, go in and I see. I j, I see, get it wonderful, getting started guides and then nothing else and it's like these people aren't serious they're selling smoking mirrors. So we need to back up the getting started guide um and we need reference pages. So we aren't bugging everything down. um We actually have a bunch of those written and I'm trying to get PR's emerged now so that other people can see them without having to read the PRS.

A

um The how-to guides right now, I just grabbed together. Pieces I could find and threw them into pages with the right title, but they really need to have some stuff, but this is how you do this, and also the contributing people are. A lot of people are saying they wanted tribute, and then it's like how do you contribute all of these files and go around and think about it? You'll put it together, but yeah. It's just getting that fixed up right. Yes, hello,.

B

A

B

And you were saying that you can't merge PR's. uh Why is that? Well.

A

We well first of all, we've got uh I think that we got tools, problems that I'm, not a fan of Diamond will be here soon, but um the the markdon Lynn I mean it's just everything gets blocked and I. Think it's a real I, don't know it's over stupid stuff like two lines between paragraphs rather than one and stuff like that, but yeah.

B

I have a I have a good solution for that which.

A

B

um So I use this for most of my repos. uh It's called a pre-commit hook, uh-huh.

B

So what it does is it will find that error before you commit and then it will fix it for you, so you don't have to do it.

A

Okay, well, markdown Lynch fixes a lot of them. Yeah.

B

But yeah, but that fixes it at the pipeline level when it's too late. So what you're saying is you know you have to you, do the commit and then it wastes time, but you could do it before you commit it'll pick it up. Yeah, that's true! So that's an option if you're getting frustrated with that.

A

That, for me, it works well because one of the things that's a semantic and the semantic stuff is just bizarre if you've only got one commit ment.

B

A

Make one I I write up the initial content and commit it and then I run mark down lit and it's changes. That's my second commit and then I'm done with the semantic crap.

B

Yeah um I, if, if you want to explore what I'm talking about, if it might make sense, uh I can show you I can today, but.

A

Actually, let's wait a minute until Simon comes because that's Simon's barely work.

B

Yeah yeah, okay,.

A

And then um content-wise have I got the principles right on what we should be prioritizing.

B

Yeah, it sounds it's out like so so just high level uh watch watch the thing, so you you're saying more people at the meetings. Well,.

A

I'm just talking about dark priorities: oh doc, priorities, yeah.

B

Which we should be working on, no yeah I think so like how they contributes a good one. um But it's got to come from the tech team as well to get good first issues and and allocate them to people and.

D

B

Do them, and um maybe uh once a month we can get together and make good first issues for people.

B

Is it probably a good one, because you know when I used to go to open source communities and say you know, I want to work on this project? If there was nothing to work on, then what are you going to? Do you just sit there and you're like oh? Do these people even want me.

A

To come right, so it's.

B

Not really inviting right.

A

Right and something I've wondered about too, is whether good first issues should be marked, because it's software and Doc as to sort of what background for.

B

Instance, it's.

A

Like if you don't, if you've never touched a go, this is not a good first issue. If you're familiar.

B

A

Oh, it is yeah.

B

We can have a docs label if we don't have one as well right, yeah that definitely works.

A

Act or something else, we could do this um at our community meetings so.

B

um Good good another good news is When Stacy joining Donald jokes or she started already. She started. Do you have you talked to her yet uh-huh so um flux? She used to work on flux, I, know Stacy from like round and about last year flux have the best um ever contribution.

B

um They call this thing called Bug scrub, so once a month they get together and new contributors come and they allocate bug tickets, which are good first issues, two of the members and everyone joins that meeting. As a new contributor start, the bug scrub for Captain, which will solve these issues. It's very very good.

A

B

Look up flux, plant scrub, um it's very impressive. Okay,.

A

She's supposed to name I.E, not y right.

B

uh I think it's why I.

A

B

A

B

A

Then why are ey.

B

A

I'll check it later and get it spelled right. um So what are have you looked at the docs lately? What do you have to say and what.

B

I have, to be honest, I haven't looked at them. Sorry, uh what I'm going to be doing is working a lot uh on the kot, so I will be able to give you feedback on the docs soon yeah.

A

That's what I'm talking about the characters? um We could look at one. One thing, that's interesting! That's up for this discussion.

A

um That's what I want.

A

A

A

The engineers now they have this to ignore that um this is auto-generated for the apis, so.

B

I'm gonna sorry I'm, not looking at the screen I'm getting ready for my swimming for my daughter's story.

A

Oh okay, can you look at the screen or do you need to.

B

I need to go yeah. Sorry.

A

B

Okay, we couldn't.

A

Get very far, then.

B

No, could we change this meeting to half an hour earlier, because then I could definitely go each time.

A

ah I could um and I guess, oh that you know. Well, we don't have anybody else, so we could.

D

Good morning, there's.

A

D

A

About to lose Brad um he's wondering he's for the same reason: well, you've got I, don't know an hour early or an hour later or Brad's about to have to go and pick up kids and we're losing him we're talking about um what did time look for you if we move it a half hour earlier or later.

B

Yeah, or even even way earlier, if it suits Simon but maybe he's getting his kids ready for yeah.

A

This is already 7 A.M for Simon yeah.

B

A

B

About what about way later and then the kids well, the people from India can come and they don't have to duck out of University. Well.

A

How much way later, like not something that's going to have me animating at 6 30 in the morning.

B

Yeah I forgot about that you're in the US.

A

Well, I'm on European kind of but I'm.

B

Perfectly happy working.

A

From Ken at night till like four in the morning, but these 6 30 meetings are starting to kill me I.

D

Can't, let's sorry yeah I I can do half an hour earlier Max, but everything else will be quite tricky regarding getting up in it.

B

Or or we can just keep the same time and then yeah you.

A

Know, yes, could you do a half an hour earlier.

A

Yes, you're muted. Yes, you.

C

A

Half hour earlier, yeah yeah.

B

Because I, don't I, don't want to get you up too early so like. Why don't we keep the time and then because next week I? Can my daughter's Gonna Change swimming lessons time anyway, so I'll be more free to do this meeting? Well.

A

Let's try to happen early and see what it helps. I'm sure that would help Adam, probably normally.

D

I would I would suggest for next week. Do it as you prefer it, because next week is a public holiday, the Thursday in Austria. So austrians are again.

D

Just just the information so well I think you can do next week, as you like, so do not take care of me as a do not handle try to handle me no.

A

Okay, let's discuss it in the slack channel for what works I'm. True I'm over we're, not getting participation. Yash says he could do a half hour earlier, so I'm all for moving it and seeing if we pick up anybody else,.

A

C

You have anything you.

A

Wanted to discuss.

C

Regarding the issue which I have made, the there are only two errors means the markdown linked one and just need to resolve them to make a perfect PR. Yes,.

A

And it's fun, isn't it? Are you having troubles with that? No Simon Simon's the expert on this? Yes,.

A

A

Did you run markdown went fix on up stuff? First of all, that'll fix some of it. I think.

C

No, no I have not done that. Well,.

A

C

Would call it steps, but yeah I will do it today. Okay, yeah.

A

I'm, free, okay and Simon you glanced at that PR. um Did you see other things or I? Just I saw a couple things.

D

I wrote some comments on this task, so I'm not sure if they're thick as if they were handled by now or not I will I need to check. um You wrote reaction.

D

I take a short look just a second.

D

No, it seems not. My things were addressed, I wrote here so yeah what I put into the so if it is the one from yesterday, there are still things which are not hundred percent uh true anymore, so there's a so where the markdown files are stored. Actually I remarked that, and there is a link in the header again so, and links links and headings are bad, at least what we decided. Okay,.

A

Yeah they're they're I I've worked with a lot of similar tools. Links and headers are never a good idea.

D

I can add later on a rule to automatically detect those if you really want to to not have them so that we have a markdown link rule failing them.

A

Yeah I, don't know part of me thinks that the quality of our markdown is not the problem. We've got with the docs, so I'm, you know so I don't know um Yash. Do you want to try to do any of this now or do you want to go up and do it on your own and come back to us? If you have problems? Oh.

C

Can I get the reference from Clint uh deck? Okay, so that I can do.

A

It okay, terrific.

A

And then, as soon as I think I may have already there's first time contributor that something that has to be done, I think I already did it, but if not I'll.

C

A

It's ready so, but it's yeah, but so um the biggies that are burning lots of us um is the title of the pr it has to be docs colon, and the next word has to begin with a lowercase letter. That's.

C

A

People um and yes, and and we don't want to have links in headers- that's probably a bad idea, um but the trick is you just make the header plain text, and then you make your topic sentence. That says you know um whatever this is it's such and such and then you can make that one give your link there.

A

So you get it right there at the top so and what else is burning people um watch out for really long lines um and the what I've, where I get burned on it is it will ignore when you've got like a. You know, something: that's a link, those things get really long, but if you say the space and then the link it'll tell you it's too long. If you put the on a separate line, so I'm just kidding so I put all the links on a separate line.

A

If it's the such and such file, it's the new line, the link and.

C

A

File s and it doesn't like more than one line between more than one space between paragraphs, but markdown lint fix will forget. That's those I think what are the other big ones that are hanging people up Simon and my I feel like I'm missing something.

A

Those are the biggies right.

A

What is the state of links to subsections of pages, mostly they're working for me, but I? Have that one that isn't working and I can't figure it out.

D

uh Which pull request.

A

A

Close some tabs.

A

um 1375 I believe.

D

D

Great Captain metrics markdown checks.

A

And it's right there at the top. It's that numbered list of what's coming and.

D

Implementing integrated is the link. He does not find right.

A

And I may have I may very well have done something stupid, but it looks to me there's a whole list of links and all the others work and that one does not integrate klt with your cluster.

D

Yeah, that's small! That's that's still! That's.

D

Just as I can um codes.

A

And on Netflix, why.

B

It doesn't work at.

C

A

My local build I can right click it and the link works, but just clicking and going down the same file doesn't work, but that doesn't, but the right clicking doesn't work on netlify, so open.

D

D

A

You want to share your screen, so we can see.

D

Yeah I'm, just in this setup, just a little just I'm, just preparing everything.

A

Oh, let us see you junk come on.

D

Sir share screen so.

D

Okay, you should see my IDE.

D

Let's start linking my complete, and we have here this issue. Okay, this link is not. It should be within the same.

D

Okay, we have here this link, this integrate.

D

It's integrate Clarity with your deployment or just this should be the link, and here it says, integrate klt with your cluster. So it's deployment here, oh shoot, and that should.

A

Fix that one that would fix that I knew I was overlooking something.

D

That's that, and but there is another one, you there's a marked on link check, I'm, not sure, there's this, oh, where was this now yeah, there's also a markdown link.

D

Integrating into.

A

Implementing flash integrate something.

D

Implementing slash integrating the file is getting started. Metrics did you also.

A

D

um So we have this getting started. Metrics, okay- and here is this in implementing integrating and when we click this link, Visual Studio tells me there is no implementing uh integrating. So actually it's just one line too much I think yeah.

A

That one isn't.

D

ah Okay, implement ah there is no integrate MD, it's implemented.

A

Implementing the well, this is a big section and then there's an integrate.md inside yeah.

D

But it's it's just, but.

A

It's got an index. Okay, I wasn't seeing that when I was just seeing the other ones now, oh.

D

You're sure you can always to integrate index.nt and then no no. What do I do wrong. I jump up the metrics, folder and I mean getting started and from getting started. Integrating. Oh it's just an index. There's no underscore! ah Yes, that's that's the thing the but I can commit those changes. Oh okay,.

A

If you want to or now that I know what to do, I can do it too. So yeah.

D

But it's done already: I will rename this index MB to underscore index ND, and now this link should also work. Yes, I click it it's pointing now to the right file and everything is working so, and this is also the one we fixed perfect.

A

D

D

Perfect should be up there.

A

Okay, thank you and I am an idiot God and that's you can stare at this stuff forever and you know what you.

C

A

Should be there and that's what I think typical.

D

Typos, but that's that's why I like to work with IntelliJ IDEA, uh because it will jump around and and jump to those links.

A

When I click on them right, I can see that it would be a nightmare for me to write that way. Maybe I need to learn to do it just for checking.

D

So one thing was also the dco failed. Okay, oh.

A

That's yeah: that's going on I'm you're not supposed to watch that that closely the high catch it as soon as it goes, and most of them are working, but this particular one is being probable. Okay,.

D

Marked on lint is now green, unmarked on link check should be or simply.

A

Yes, do you work in an IDE, or do you use a straight editor.

C

uh You just straight editor.

A

Do you switch I, didn't understand that? Did you what.

C

It is okay, so basically can I get the guy. I can say documentation for the markdown link. One. Is it there in the captain, Docs.

A

The documentation for what the markdown link- uh actually it's in that winter section that's in this PR, isn't it.

D

Marked on link we do not have but markdown linked is.

A

Markdown wit checks the links too yeah sure.

A

Output in the world to try to read through that yeah.

A

And uh yeah some of this we just didn't get around to updating, um feel free to add some information to the stuff that you're working on right.

C

Now, starting at the beginning of the uh I can say, whenever we click on the link, we get to a point where there should be a starting title and a description for the whole PR to get merge.

A

Yeah I think so yeah and will, or- and you and by the way it's also it's not a bad idea to just get a PR merge and then go back and do another PR to add to it. But.

C

A

But I've been aware of that, the well partially, because I've got some other so much other stuff going on plus contributing guide. All these people are working on it. There have been changes that have been made and I thought that should be added to the contributing documents like. Oh, why complicate it by me, jumping in with a PR on just with, though I haven't kept it up so we'll get it together, though, it'll be fun.

A

Though so you're ready to go forth and do what you need to do- Yash, yes, ma'am.

C

A

Okay, anything else. Anybody um Simon, you got anything to Enlighten us with this time. No.

D

I'm, no there's nothing for my site.

A

Okay, so sure are we ready to call it a meeting?

A

Yes, cool cool thanks everybody! So next week we'll meet a half hour earlier and see how that goes, except for Simon who will be on holiday because he lives in Austria.

C

A

Sure, okay, terrific we'll talk to you next week, bye.

C

Thank you, bye.

A

C

Bye Meg, bye.