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

Update scheduler documentation #3692

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Conversation

jpbruinsslot
Copy link
Contributor

@jpbruinsslot jpbruinsslot commented Oct 16, 2024

Review notes

I've opted for not using mermaid because of inflexibility of placement of elements. I can investigate further if it might be possible to create the same diagram from the images that I've included. However, unless someone has a good example that this would be possible I don't want to spend too much time on this.

Changes

Since the introduction of flexible scheduling and the report scheduler the documentation about the inner workings of the scheduler is out of date.

Issue link

Closes #3121

QA notes

  • Thoroughly read through the documentation. This will be on the test!

Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@jpbruinsslot jpbruinsslot self-assigned this Oct 16, 2024
@jpbruinsslot jpbruinsslot added mula Issues related to the scheduler chore labels Oct 16, 2024
@jpbruinsslot jpbruinsslot changed the title Chore/mula/documentation Update scheduler documentation Oct 18, 2024
* main: (25 commits)
  Add sterr to output list (#3649)
  feat: ✨ add Shodan InternetDB boefje (#2615)
  Add search endpoint for schedules for scheduler (#3695)
  Fix/report naming (#3666)
  Add delete schedule functionality for schedules in the scheduler (#3678)
  Fix javascript and component template in prod environments (#3672)
  Fix first order dangling affirmation delete (#3682)
  Do not run dh_strip_nondeterminism in Debian packaging (#3674)
  Github action should trigger if workflow definition changes (#3680)
  Updated packages (#3694)
  Silence KATFindingType not found error in JobHandler (#3686)
  Add docs for xtdb analyze bits. (#3688)
  Fix empty vulnerability reports (#3662)
  Fix jsonb 'contained by' query (#3643)
  Add plugins to findings report (#3657)
  Translations update from Hosted Weblate (#3673)
  Update upload_raw.py (#3645)
  Add rocky worker service to debian packages (#3619)
  Fix/yielded objects (#3669)
  make some things look better (#3661)
  ...
@jpbruinsslot jpbruinsslot marked this pull request as ready for review October 24, 2024 10:02
@jpbruinsslot jpbruinsslot requested a review from a team as a code owner October 24, 2024 10:02
Copy link

sonarcloud bot commented Oct 31, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore mula Issues related to the scheduler
Projects
Status: Review
Development

Successfully merging this pull request may close these issues.

Flexible scheduling: update documentation
2 participants