Continuous Delivery Foundation Ortelius Project Meetings, 7 Dec 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: 9:30 AM - Utkarsh Sharma - Getting yourself setup to start contributing code to Ortelius

Description

Learn from Utkarsh how to become a ‘powerhouse’ open source committer. Utkarsh will walk through the steps you need to go through to setup your local environment and begin working on Ortelius Issues and create Pull Request. The lessons learned can apply to many Open Source projects. This is your chance to learn from one of the best. Thank you Utkarsh for your amazing work and contributions.

A

Hello: everyone um welcome to our telugu's microservice visionaries 2021.

A

I hope everyone is doing great. My name is utkarsh and I'm the presenter for this presentation and today I'm going to walk you through how you can set up yourself and start contributing to artelia's open source project.

A

So, let's get started.

A

uh Before going further, let me give you a brief idea about what our daily surprises project is.

A

So what else open source project is basically a micro service management platform, as we all know, in microservice architecture, we have a lot of decoupled pieces and there comes the problem and artillery is trying to solve that problem by cataloging. A lot of information for those decoupled pieces like the version details, the tracking microservices, the blast radius and much more other information.

A

So the user can proactively monitor those microservice components and the changes that are happening over time. Ateliers is an incubating project under the awareness of cd foundation, which is a foundation under linux foundation.

A

The mission is to simplify this adoption of microservices to creating this world-class microsoft management platform, which is driven by a supportive and diverse open source community.

A

As I told you uh we'll be discussing a lot about how you can contribute to artelia's workpiece, so if you are a person who wants to start their open source journey or if you're a person who is stuck somewhere in his or her journey, so this is the right presentation for you, because the lesson that you'll be learning through this presentation, you can apply them anywhere to many other open source projects.

A

Let me introduce you to myself, I like to say myself as a cloud enthusiast, because I like to create solution using different cloud platforms and I'm an open source contributor and currently working full-time, the consultant in capgemini india.

A

You can also follow me on github and medium using these handles.

A

These are the agendas for today, as you can see, we'll be starting our discussion at very basic level that is joining the community and eventually uh will go how you can you know, uh contribute to artelias as a developer.

A

So let's see these topics one by one in the coming slides.

A

Okay, so you are a person who wants to start their open source journey. So what is the first step that you need to take?

A

So, first of all, you need to join that community, so in artelias we have made it very minimalistic and very simpler. So this is the url that you need to navigate to, and this url this web page has all the information that you need in order to become a contributor or artist community.

A

I won't be discussing a lot of things here, but I would focus on two points that are joining the discord channel and joining the artiles google groups.

A

So why why it is very important to join the discord channel, because a lot of discussion happens there and we have like people all over the world who discuss their problem statements and their strategies.

A

You can also you know, participate in the live discussion and share your ideas and the other thing is arterious google groups. So once you join that authorized, google group, you will get notification for all the calendar invites for the artillious meetings, and, apart from that, we share all our documents with the artillious google group.

A

So if you are a part of that, you will have that access to the artifacts that we share there and there is a bonus sign up url as well on the contributor page, wherein you can fill a simpler form and someone from particular team will reach out.

A

Once you have joined the community reach out to the community for any questions, any queries that you have.

A

Let me introduce you to steve taylor, who is a cto, deploy hub and a telis architect, so you can take advantage of steve's, open door policy and schedule time on his calendar if you are working on any issues, if you are stuck at some issues or if you need to discuss something, you can navigate to this url for accessing his calendars and, alternatively, you can always post your questions on discord and community will always try to help you.

A

Okay, so you have joined the community what next so now you have to create your first full request. What is the phosphor request? So, as the name suggests, this is the first pull request that is generated for an organization.

A

So all our project code base can be found on this official github repository for artelias, which is github.com, slash, artelia, slash ortelius, so you have to fork this repository and edit a readme file there and you have to add your name to the contributors.

A

uh Well, once you have done the changes, you save that and create a pull request for your change and that's it. You have created your first prerequisite.

A

Congratulations, but if you are a contributor who is contribute, who has, you know, started their contribution for the very first time, then you also need to sign a linux foundation dla.

A

So if you are getting some mails regarding signing a linux foundation, cla then make sure you go ahead and sign that out, because until unless you sign this cla, your pull request will not be requested, will not be accepted.

A

Okay, so you have joined the organization and you have also created your first prequest congratulation, but what? Next? So now? You have to pick up your first issue and this will be the issue that you'll be working on, and this is how you contribute to the organization.

A

But since you have newly joined to the organization, you would not have much idea about the product. So how would you choose the issue so for that there are some labels on the issues, so you have to choose the issues that are labeled as code first issue or documentation issue. The reason that I'm telling you to do so because the good first issues are issues that are simple and easy to implement and documentation are issues that would require you to create a documentation or update an existing document.

A

So with this process you will understand the application, and eventually you can pick up any issue that you want.

A

Also documentations are no easy way to get started to know your application and if you are not sure like which issues to pick up, don't worry you just put them down in this card channel and people will help. You pick up the issues as well, and you don't need to be afraid of choosing any issues to work on, because obviously there will be people there will be mentors who will be guiding you throughout the process and helping you out whenever you are stuck at some place, go ahead and pick up your first issue.

A

So if you have a picked up issue that is a documentation issue, then you will need to install a couple of things in your local machine to get started to work on documentation issue. So there is something called hugo server which renders your markdown file. So you need to install that into your local machine so that you can render your documents um like.

A

How would they look and you can preview your source code and, if you're working on visual studio code, then they have a very useful extension that is markdown preview enhanced by rank which you can install and that will give you a split window or your source code of the documentation.

A

So that way you can see the preview of your documentation on the same screen while you edit up your source code.

A

If you have a task where you want to update the existing document so navigate to the documentation, I start your hugo server and make make changes in the documentation and whatever changes that will make will be rendered automatically. On the right hand, side.

A

I have this screenshot of how it looks like so, as you can see, on the right hand, side you have the preview, which is a rendered section of the source code that you have written on the left hand side.

A

So, in this case on the same screen, you can edit up your source code and see how would they look like in the previous screen.

A

Okay, so what if you don't want to do some coding or if you don't want to do some documentation changes? Don't worry, are you a content creator or want to be one we'll give you a platform?

A

We have a artelias channel on youtube and you can create videos for that. We are running arterius officers.

A

You can be a part of that. You can interview someone or share your story. Ideas through artelia's offices,.

A

If you are good at marketing, join our outreach community create campaign for marketing and will help you in all the possible ways to achieve a task.

A

You can also be a mentor.

A

um You can use your expertise to mentor people achieve their tasks and there are like many more opportunities that you might get. All you need to do is to join the meetings and volunteer yourself for any tasks that you hear.

A

Bring your ideas.

A

So let's say: if you have some idea that, if integrated with artelias or solve a problem, so we would appreciate if we can bring that idea to the community, propose that idea and discuss it with community and we are looking forward to new ideas and features that we can introduce in artelias to help solve your problem.

A

uh You can also share your feedback to us and we look forward to this feedback to make sure uh we are solving the right problem.

A

Being recorded for arterius, this slide talks about uh what technologies that we use and, obviously what opportunity that you have in terms of learning different technologies.

A

So we we have quite a range of technologies that we use the programming languages that we use primarily are python node.js golang, uh the cloud platform that we use is gcp and assure for deployment. We use docker cuban natives and helm, and obviously we know why we are opting these technologies, because python python is very easy to learn and python has become a lot of a lot popular since it is very easy to run.

A

It has a lot of libraries that we can leverage the code, readability and creating your proof of concepts using python is very easy, and python has also a strong integration with our other technologies, and we can leverage that part for node.js.

A

It's been in industry for quite a long time, and we have tons of libraries and modules that we leverage and node.js is. Obviously we have multiple options for input output operations, so that comes as an advantage of using node.js.

A

Why we use scrolling cooling is coming as a very popular language. These days, due to the advantages who has the core is built for work, which has a lot of complexity.

A

Go primarily focuses on writing a performance solution, since all the it has a lot of inbuilt features of concurrency and asynchronous communication. That is why we are also using global.

A

Okay, so what do you have to do uh for contributing as a developer in arterius? So obviously you have to set up your local machine.

A

We have uh our official repository, that is github.com material, slash artelias and it has all our uh codes and so.

A

And uh we open all the issues uh at this repository because we don't want to open the issues at multiple places. So this is the one place where you can find all the issues related to our teles project and you can check out your project or microservices that you have to work and you can set up your local testdb to run your application.

A

How you can do that, so we have already created a test database image that you can pull using docker and there are a few of the commands that you can find on the official repository as well.

A

So, first of all, you would need to pull out the test database image and you need to create a volume for that and after that you can run that image file using that volume on on any port that you need.

A

Okay, so devops is not yours, so here are a few things that I would like to mention uh as part of what github action that we follow and other security and cloud build details. So.

A

So, as you all know, github action is basically the workflow that is defined in github, so we have a couple of steps there. So what we do we first of all uh scan the container. um We do the more check like if the pull request has conflict on merging with the existing code base or not. We do the code in base scanning and we then release the chart so make sure um you are also whenever you are doing a pull request, make sure these uh workflows are getting checked um correctly.

A

And apart from that for every repository for every microservice, we have a cloud build so cloud. Build basically, is a deployment manifest for google cloud platform and it has all the necessary information that would be required uh in order to deploy that application to the gc.

A

So make sure uh you are you know. If you want to make any changes in the deployment, then you make sure you are making those streams in a cloud build rtml that is present. In the repository uh for security scanning, we use quite a few libraries.

A

We have trivis cyclone tv and safety, so we use these libraries to scan our code for finding the vulnerabilities in the dependencies that we use and also in our rtls dashboard. We create we leverage these features and create a cve file that we show up there in nortelis dashboard.

A

So if you have any questions, uh you can ask me please to contribute into our delis open source community.

A

uh Thank you uh or for more information. uh The official website for our tea list is rtls dot. Io, the official github repository is ether.com artelias ortelius.

A

You can follow articles on linkedin, the url is given here and you can. The twitter handle for delis is at artelias os, and you can also follow me on twitter and linkedin using these.

A

So that's all for this presentation.

A

uh I hope it gave you uh insight of how you can start your open source contribution with artelias.

A