packit / packit.dev

packit.dev website content
https://packit.dev/
MIT License
9 stars 50 forks source link

Document 'tmt_plan' and 'tf_post_install_script' #491

Closed csomh closed 2 years ago

csomh commented 2 years ago

Was introduced in packit/packit#1619.

TomasTomecek commented 2 years ago

ah, I just realized Rodolfo already resolved this in https://github.com/packit/packit.dev/pull/489

pity he didn't link the docs PR with the p-s PR

csomh commented 2 years ago

Shouldn't we document everything on https://packit.dev/docs/configuration/, too? In order to have a single page where everything can be found in a single place.

TomasTomecek commented 2 years ago

oh, I missed it's in the testing-farm document and not the configuration; agreed!

TomasTomecek commented 2 years ago

There are only links in configuration.md pointing to testing-farm. Do we want to keep this trend or actually have a single page with all the configuration values?

csomh commented 2 years ago

I'm not sure, but so far I found it handy to be able to open the configuration page and look up any configuration option.

As a user I would expect something like this, or if there are more options, then maybe multiple pages, but then it should be clear which page covers what. Right now I don't think it's self-explanatory that the "Testing Farm" page also documents configuration, or that the Configuration page doesn't document options related to Testing Farm.

TomasTomecek commented 2 years ago

+1 I also grep mostly when looking for a config option

lachmanfrantisek commented 2 years ago

Related to #467

csomh commented 2 years ago

Closing. #467 should fix this.