coopnorge / provider-github

Apache License 2.0
23 stars 11 forks source link

fix doc for deploy key #66

Closed tomasmota closed 3 months ago

tomasmota commented 3 months ago

Wonder if going forward we could just change this comment to something generic, to make sure no-one gets it wrong again... the name is 2 lines below anyways.

AtzeDeVries commented 3 months ago

yeah fair point, there are many comments in this resource which are related to the branch resource instead of the deploy_key. Maybe we should get rid of all the comments by default since this structure is used everywhere and just needs commenting once somewhere (probably docs). Only for special occasions, https://github.com/coopnorge/provider-github/pull/66/files#diff-0c12d37127a4c951074055ed83507c363c199d182a12a9ed3561e30d7fa976e3R27 a comments is required. What do you think?

tomasmota commented 3 months ago

Totally agree, but long term it would probably also make sense to group resources by group into the same package, as I have seen most other upjet providers do, e.g. :

This would make it easier to add new resources, find related resources, and remove the need for all the error-prone boiler-plate.

AtzeDeVries commented 3 months ago

https://github.com/coopnorge/provider-github/issues/69