SK-98 / Simkube AMI docs

[ogorman89]

Related Links

• https://linear.app/acrl/issue/SK-98/documentation-for-the-amis

Description and Rationale

Drafts of a few docs for AMIs, I called this section Infrastructure but would love a suggestion:

• overview.md - a basic rundown of offerings
• amis.md - a little more detail on the AMIs, I expect this page to grow more over time?
• usage.md - high level how to find/use the AMIs
• github-runners.md - high level using the SimKube Action Runner AMI
• two quick start guides:
  • run-sim.md - basic how to run a sim on EC2
  • ci-sim.md - basic how to setup ci runners using GitHub actions and simkube-ci-action

How

• mainly keyboard, some hair tearing

Test Steps

• none

Other Notes

• I could use some help calibrating this, it feels... verbose but also I expect most people will just go to the quickstart stuff?

• [ x ] I certify that this PR does not contain any code that has been generated with GitHub Copilot or any other AI-based code generation tool, in accordance with this project's policies.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.35%. Comparing base (dab53bc) to head (d25c3a2).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #218   +/-   ##
=======================================
  Coverage   74.35%   74.35%           
=======================================
  Files          63       63           
  Lines        3709     3709           
  Branches      181      181           
=======================================
  Hits         2758     2758           
  Misses        846      846           
  Partials      105      105           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[drmorr0]

You can test how this will actually appear on the web by changing the branch name in the www repo to point to your branch:

https://github.com/acrlabs/www/blob/main/simkube.yml#L70

Then on your laptop you can run just run simkube and see the whole website at localhost:8001 (sadly the live updates thing doesn't work for the cross-repo docs, though, so when you make changes you have to push them to your branch, kill the mkdocs process, and restart it).

[drmorr0]

These headings are probably going to be too long for the sidebar if I had to guess

[ogorman89]

You can test how this will actually appear on the web by changing the branch name in the www repo to point to your branch:

https://github.com/acrlabs/www/blob/main/simkube.yml#L70

Then on your laptop you can run just run simkube and see the whole website at localhost:8001 (sadly the live updates thing doesn't work for the cross-repo docs, though, so when you make changes you have to push them to your branch, kill the mkdocs process, and restart it).

Did that and caught a few more errors!

[ogorman89]

The updated sidebar:

[drmorr0]

The updated sidebar:

[image]

Oh! I've got it. Instead of "Prebuilt Simulation Environments", call it "SimKube in the Cloud"

[ogorman89]

I think I have addressed all the comments.

Several TODOs left:

• add links to AMIs in marketplace once they are both live
• add simkube-ci-action sub-docs (these are WIP)
• add troubleshooting section