docs: add github action workflows to update README on DockerHub

[CodeLieutenant]

• Update README and make it a basic documentation for running cassandra-stress.
• README is propagated to DockerHub where cassandra-stress image is uploaded after release

Closes #5

[fruch]

@annastuchlik

we want to embed this one into core docs as well
in scylladb/scylladb#21723

any advise on how to keep them in sync ? maybe just reference this repo from the core docs ?

[CodeLieutenant]

@annastuchlik

we want to embed this one into core docs as well in scylladb/scylladb#21723

any advise on how to keep them in sync ? maybe just reference this repo from the core docs ?

The main issue is that core docs are written in RST, and this one is in Markdown, Dockerhub does not support RST (tried it first), so keeping them in sync is a bit tricky, unless we do some translation between the two. Just referencing this page, does not look good on documentation site.

I can try something with GitHub Actions to translate MD to RST and open PR to core repo with DIFF from Markdown. Is that ok solution @fruch?

[annastuchlik]

we want to embed this one into core docs as well in scylladb/scylladb#21723

any advise on how to keep them in sync ? maybe just reference this repo from the core docs ?

Instead of duplicating content, I would add a reference in the core documentation. I think we should create a new page, briefly describe what cassandra-stress is used for, and add the links to:

• the cassandra-stress repository
• the page on DockerHub

Apart from the duplication, there are more reasons not to mix the two docs sets, such as different versioning and quality policies. For example, user-facing documentation shouldn't include information such as The latest version of cassandra-stress at the time of writing this document is 3.17.0. Please check the latest version on . . . .
In fact, we shouldn't mention versions in versioned documentation.

[annastuchlik]

@CodeLieutenant @fruch
I've confirmed with @tzach that we want to stick to our policies: projects should contain their own documentation (i.e., we should not document external tools in the ScyllaDB core documentation). We have two options:

• Create a separate minisite for cassandra-stress (cassandra-stress.scylladb.com), but there isn't enough content to justify that.
• Add the links to this repo and DockerHub to the ScyllaDB documentation.

We should do the latter.