search

prometheus-operator / website

The Prometheus Operator & kube-prometheus website
https://prometheus-operator.dev
Apache License 2.0
13 stars 25 forks source link

Add a CONTRIBUTING.md file for contribution guide. #110

Open Suraj-kumar00 opened 1 month ago

Suraj-kumar00 commented 1 month ago
slashpai commented 1 month ago

@AshwinSriram11 Since you are most familiar with website now, can you guide? :)

Suraj-kumar00 commented 1 month ago

Sure let's do it .

AshwinSriram11 commented 1 month ago

You can check out https://prometheus-operator.dev/docs/getting-started/installation/ for installation, pre-requisites and https://prometheus-operator.dev/docs/community/contributing/ for contributing.

ArthurSens commented 1 month ago

@Suraj-kumar00 can confirm, but I believe he is talking about the website, not prometheus operator.

If someone wants to contribute to the website, how does one set up the development environment, how does the contributor flow works here?

Suraj-kumar00 commented 1 month ago

@Suraj-kumar00 can confirm, but I believe he is talking about the website, not prometheus operator.

If someone wants to contribute to the website, how does one set up the development environment, how does the contributor flow works here?

Yeah @ArthurSens, you got it.

AshwinSriram11 commented 1 month ago

My bad! :grimacing: Currently, we only have the Readme for this repository. Setting up the website locally is explained in the readme and is pretty clear according to me, what we need to explain is how this repo and the main repo are functioning for the website.

Have you played around with the repo? Do you need any help? @Suraj-kumar00

Suraj-kumar00 commented 1 month ago

Hi @AshwinSriram11, yes i know that but as I know every os project has CONTRIBUTING.md file as usual so I create the issue but if it don't require for this project than its okay.

AshwinSriram11 commented 1 month ago

First, look into the synchronization.sh file which mentions the repositories that are being pulled for the needed docs. Then, from those repositories, we copy the docs needed for each guide of the website.

Then, all the docs that we copy go into the content folder, where each doc is copied to the location mentioned in the synchronization.sh file. To make changes to the pages on the website, you need to make changes to the docs in the source folder and then use make to pull the updated docs to this repo. Then, you can run hugo serve to view the updated website locally. TLDR, you need to open a PR in the main repo to change the .md file and make another PR in the website repo to preview it. If you add a new page, you need to also add a head content in each page to manage the order of the pages in the website.

Another part of the website is the styling. We are using a template from Doks to manage the CSS of the website. You can check out the template in the themes folder. But, if you want to make changes to the template then you would need to write your own html and css for a component. Example: Check out the layouts folder and you will find a link-card.html file which is used to style the card component in the website.

AshwinSriram11 commented 1 month ago

Hi @AshwinSriram11, yes i know that but as I know every os project has CONTRIBUTING.md file as usual so I create the issue but if it don't require for this project than its okay.

We definitely need a contributing page. I was writing about how things work in this repo. You can pick this issue up :+1: