nautobot / nautobot-app-golden-config

Golden Configuration App for Nautobot.
https://docs.nautobot.com/projects/golden-config/en/latest/
Other
100 stars 57 forks source link

Docs Update: Mention dunder init requirement for custom compliance #654

Open jeffkala opened 1 year ago

jeffkala commented 1 year ago

Should be some mention in the documentation for custom compliance that the folder with the custom logic needs to be a module, hence requires the __init__.py file.

https://docs.nautobot.com/projects/golden-config/en/latest/user/app_feature_compliancecustom/#example

itdependsnetworks commented 1 year ago

This should be the only requirement:

This is the string representation of the function and must be in Python importable into Nautobot and the workers.

It is already documented. There are likely many things to consider to "be Python importable into Nautobot", but I wouldn't single this one out as it implies we would like all of them.