[STAL-2379] docs: document how to use the Docker container

DataDog / datadog-static-analyzer

Datadog Static Analyzer

https://docs.datadoghq.com/static_analysis/

Apache License 2.0

100 stars 12 forks source link

[STAL-2379] docs: document how to use the Docker container #434

Closed amaanq closed 3 months ago

amaanq commented 3 months ago

What problem are you trying to solve?

We do not have any documentation on how to use our Docker container

What is your solution?

Add docs

Alternatives considered

What the reviewer should know

juli1 commented 3 months ago

We should update the Quickstart section of the README.md and show the command to use the container directly from there.

This way, people do not have to download anything. Docker is common among everybody and users can try the analyzer in one command-line.

juli1 commented 3 months ago

We should also write about using a pinned version. A lot of user want to use a pinned version to prevent regressions. We should put something about it here.