[RELENG-7422] 📝 Add documentation

[gaspardmoindrot]

No description provided.

[codecov-commenter]

Codecov Report

Merging #42 (096fee9) into main (6f4b71e) will increase coverage by 1.29%.
The diff coverage is 97.76%.

@@            Coverage Diff             @@
##             main      #42      +/-   ##
==========================================
+ Coverage   96.15%   97.44%   +1.29%     
==========================================
  Files          10       14       +4     
  Lines         442      509      +67     
==========================================
+ Hits          425      496      +71     
+ Misses         17       13       -4     

Flag	Coverage Δ
api	97.36% <97.62%> (?)
unit	19.41% <37.11%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
gh_actions_exporter/main.py	96.07% <88.23%> (-1.49%)	⬇️
gh_actions_exporter/metrics.py	92.24% <91.89%> (+3.90%)	⬆️
tests/api/metrics/test_job.py	98.80% <98.80%> (ø)
gh_actions_exporter/Webhook.py	100.00% <100.00%> (ø)
gh_actions_exporter/config.py	97.22% <100.00%> (+0.44%)	⬆️
gh_actions_exporter/cost.py	100.00% <100.00%> (ø)
gh_actions_exporter/types.py	100.00% <100.00%> (ø)
tests/api/conftest.py	100.00% <100.00%> (ø)
tests/api/metrics/conftest.py	100.00% <100.00%> (ø)
tests/api/metrics/test_workflow.py	100.00% <100.00%> (ø)
... and 2 more

[tcarmet]

It's a very good piece of doc, but some of the content are specific to us (scality) and this is a public project.

Keeping this in mind you have to write the doc in the context of the project itself:

• it does not know about gcp or aws, but a quick mention can be added
• large xlarge etc labels are only used in our context or depending how users have configured their github org

[gaspardmoindrot]

I mimicked the syntax present in the devdocs repository, but unfortunately, trunk check is causing issues here. I will find a solution. If I try other methods, it still doesn't work, either in terms of the display or with trunk.

[gaspardmoindrot]

I ended up using <!-- trunk:ignore --> after all; I couldn't find any other solution.

[tcarmet]

We're very close to merge this one, checkout the open conversation (one may be hidden as it's outdated) and we're good to go 🚀

[tcarmet]

still one open conversation.

[gaspardmoindrot]

still one open conversation.

There were 2 of them open, I just noticed the other one, I'll take care of it.