Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Jobs Developer Guide is ambiguous when it comes to register_jobs() #4805

Closed
dylanbob opened this issue Nov 15, 2023 · 1 comment · Fixed by #4872
Closed

The Jobs Developer Guide is ambiguous when it comes to register_jobs() #4805

dylanbob opened this issue Nov 15, 2023 · 1 comment · Fixed by #4872
Assignees
Labels
type: bug Something isn't working as expected

Comments

@dylanbob
Copy link

Environment

  • Nautobot version (Docker tag too if applicable): documentation of the v2.0.4
  • Python version: n/a
  • Database platform, version: n/a
  • Middleware(s): n/a

Steps to Reproduce

  1. Head to the jobs developer guide
  2. Discover how custom jobs are developed and what changed since earlier nautobot versions
  3. Be mislead by the documentation and fail to develop a job 👎

Expected Behavior

The documentation should :

  1. clearly state how, when and where register_jobs() must be used
  2. 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)
  3. 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.

See my corresponding message in the Slack.

@dylanbob dylanbob added triage This issue is new and has not been reviewed. type: bug Something isn't working as expected labels Nov 15, 2023
@dylanbob
Copy link
Author

This issue is also somewhat related to #2727.

@lampwins lampwins removed the triage This issue is new and has not been reviewed. label Nov 16, 2023
@gsnider2195 gsnider2195 self-assigned this Nov 22, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: bug Something isn't working as expected
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants