tofu-controller icon indicating copy to clipboard operation
tofu-controller copied to clipboard

Docs Issues

Open dfreilich opened this issue 3 years ago • 2 comments

I've had a few issues with the TF Controller in the past few days, and wanted to give some suggestions to the docs as a result:

  • We set autoApply to the only other enum value, which was disable, and didn't realize that that would disable planning as a result (as documented here). It would've been helpful if that was also documented here, so the use of that flag would be clear.
  • The documentation about custom-backends here doesn't mention the ability to add fields from secrets or configMaps, as mentioned in this issue
  • There's little documentation on what certain fields in the spec do, like force (I totally didn't realize that that would do the same as setting autoApply: auto). Even just adding more docs in the code comments, so that they show up in the API Documentation, could be really helpful (for instance, before we found these docs on forceUnlock, we went hunting through the code to understand the behavior)

Thanks for all the work on it!

dfreilich avatar Jan 05 '23 08:01 dfreilich

Thank you so much @dfreilich !!

I'll improve the docs per your suggestions.

chanwit avatar Jan 05 '23 10:01 chanwit

Hello @dfreilich, it's been a while. :) Would you be open to making a PR to implement this change? Thanks much.

lasomethingsomething avatar Nov 08 '23 16:11 lasomethingsomething