Documentation Update #4468
Documentation Update #4468
Conversation
| ## RabbitMQ | ||
|
|
||
| The application server sends tasks to a [RabbitMQ](https://www.rabbitmq.com/) | ||
| message queue for asynchronous execution. |
There was a problem hiding this comment.
@StefanFl the architecture page is not accurate. DefectDojo is not strongly linked to RabbitMQ.
DefectDojo rely on Celery. Celery can leverage RabbitMQ for message passing but this can be replaced by Redis or another system.
I would prefer to have something more high level in this page. If you really want to talk about implementation, you can redirect users to https://docs.celeryproject.org/en/stable/getting-started/brokers/index.html#broker-overview
There was a problem hiding this comment.
I agree with @damiencarol, we should have the term broker maybe instead, and list rabbitMQ as being possibly the default for us.
There was a problem hiding this comment.
Possibly some double-edges arrows in some places.
There was a problem hiding this comment.
Yes, having a Message Broker in the diagram, with a reference to RabbitMQ and Redis in the text is much better.
And can do some double-edge arrows as well.
|
@StefanFl made some comment but accepting as documentation can be improved/modified all the time. |
docs/content/en/usage/models.md
Outdated
| @@ -0,0 +1,77 @@ | |||
| --- | |||
| title: "Core data classes" | |||
| description: "DefectDojo is based on a model that allows the ultimate flexibility in your test tracking needs." | |||
There was a problem hiding this comment.
Not sure about that "ultimate flexibility" yet, maybe we could reword it :-)
There was a problem hiding this comment.
Copied it from somewhere but maybe it's really a bit much. Will reword it.
|
The last commit fixed the problem with the wrong link, @valentijnscholten pointed it out on Slack. Unfortunately we now get some links on the top right for editing the page and submitting issues. See https://stefanfl.github.io/django-DefectDojo/integrations/import/ for an example. The other option would have been no links to GitHub but a last modified date of 1.1.0000 or so. For me this PR would be ready to merge |
|
Thanks again. |
With this PR the documentation gets a much better flow. You can see how it will look like at https://stefanfl.github.io/django-DefectDojo/.
Apart from some reorganisation and lots of details there are some noteable changes:
I am not completely happy about the Features page. DefectDojo has a lot more features, that are not mentioned here. And is everything still up-to-date? Maybe we find volunteers for that.