You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Discover how custom jobs are developed and what changed since earlier nautobot versions
Be mislead by the documentation and fail to develop a job 👎
Expected Behavior
The documentation should :
clearly state how, when and where register_jobs() must be used
match the example with the explanatory text : either both jobs.py and jobs/ options should be explained and shown with an example, or only one of both (in that case, the jobs/ seems better)
be written from the 2.X standpoint, but a more general issue, #4760, already covers that
Observed Behavior
In the documentation :
the only occurence of register_jobs() is inside a "Changed in version 2.0.0" block, and it mixes in developing jobs and developing plugins providing jobs
the example of register_jobs() does not match the documentation text : while the example is for jobs.py, the text is for jobs/, which changes where the register_jobs() should be put
Additional information
register_jobs() is now mandatory, therefore its documentation should be crystal clear.
Environment
Steps to Reproduce
Expected Behavior
The documentation should :
jobs.py
andjobs/
options should be explained and shown with an example, or only one of both (in that case, thejobs/
seems better)Observed Behavior
In the documentation :
jobs.py
, the text is forjobs/
, which changes where the register_jobs() should be putAdditional information
register_jobs() is now mandatory, therefore its documentation should be crystal clear.
See my corresponding message in the Slack.
The text was updated successfully, but these errors were encountered: