Generate and publish dashboard into documentation

[adpaco-aws]

Description of changes:

Generates and publishes the dashboard into rmc-docs, where we have included a dedicated section and the dashboard itself.

Resolved issues:

Resolves #484

Call-outs:

If approved, the dashboard step will be restricted to run in the same way as the publication step.

Testing:

• How is this change tested? See the CI run here.

• Is this a refactor change? No.

Checklist

• Each commit message has a non-empty body, explaining why the change was made
• Methods or procedures are documented
• Regression or unit tests are included, or existing tests cover the modified code
• My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

[tedinski]

1. I believe we discussed running the dashboard generation only on push to release?
2. Do we have any mechanism to timeout a dashboard run overall? I'm worried if it was flaky about nontermination to start then maybe we'd need to worry about that again? I don't want to end up with github actions running for... presumably some default timeout?

[tedinski]

Well litani didn't work, so I guess we still don't have a sense of how long it'll take in CI

ModuleNotFoundError: No module named 'dataclasses'

[adpaco-aws]

In response to your questions:

1. Yes, but I wanted to test this on the PR first (it was worth it).
2. Unfortunately not (see Timeouts have no effect during dashboard generation #491). I was thinking maybe try tools like timeout <dashboard-command>?

Well litani didn't work, so I guess we still don't have a sense of how long it'll take in CI

ModuleNotFoundError: No module named 'dataclasses'

We are actually getting three different errors. For macOS we get the one below:

thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Os { code: 35, kind: WouldBlock, message: "Resource temporarily unavailable" }', src/tools/dashboard/src/litani.rs:93:48

I think this is due to the MacOS runner being too slow, basically.

The error on Ubuntu 20.04 is:

FileNotFoundError: [Errno 2] No such file or directory: 'dot'

Because we need to add litani dependencies.

[adpaco-aws]

Okay, that worked (50 minutes). Saving the run here.

I am going to apply the final changes now.

[avanhatt]

Nit: grammar, either "RMC Dashboard's purpose" or "the purpose of..."

[adpaco-aws]

Please check the new version.

[avanhatt]

Maybe more description, like "all Rust code snippet examples from the following general Rust documentation books"

[adpaco-aws]

I extended it a bit but would like to extend and review this in a follow-up PR, so opened #509

[avanhatt]

Could you add a line to the README about running install_deps.sh?

[adpaco-aws]

I followed @zhassan-aws advice to put this into its own script. Do you want to use install_deps.sh in our README like we do in rmc-docs?

[zhassan-aws]

Do we really need to add gnuplot as a dependency to RMC? It brings in a ton of other packages. Since the Installation section of the tutorial refers to install_deps.sh, can we perhaps put gnuplot in a separate install_dashboard_deps.sh that is only run in CI?

[adpaco-aws]

I liked this idea so I added it. The script is only run in the workflow when the dashboard is going to be generated.

[adpaco-aws]

Following @avanhatt's advice, I have updated our README to point to rmc-docs so the quickstart section is simplified and we have installation instructions in one location. You can see a preview here, let me know what you think.