Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs: misc readme upgrades

See original GitHub issue

Follow-up to #617

replace #cml-functions table with auto-generated collapsed command --help (#361)
talk about runners after #583 (#684)
- transparent spot instances
- avoid timeouts limitations
review PAT necessity #625
- also PAT section (at the bottom of the readme for self-hosted runners) is easy to miss
- also explicitly mention adding PAT to secrets?
~~maybe more reordering à la https://github.com/iterative/cml/pull/617#issuecomment-872151100~~ #718
Specify cloud user privileges required? (https://github.com/iterative/terraform-provider-iterative/issues/75, https://github.com/iterative/cml/issues/429#issuecomment-791641276) (#684)
- e.g. @dberenbaum’s IAM user did not initially have privileges for ec2 creation/destruction/etc
- might be hard to specify for each cloud provider, but details about what privileges are needed would be helpful
~~how to use GPUs https://github.com/iterative/cml/pull/667/files#r674755174~~ #718
- image: docker://...-gpu
- options: --gpus all
- cml-runner --cloud-type
- (optional) cml-runner --cloud-gpu
~~how to use on-premise~~ #718
- GH/GL self-hosted/managed runner (not cml-runner)? Cons: GH 72h timeout?

Issue Analytics

State:
Created 2 years ago
Reactions:1
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

casperdclcommented, Sep 17, 2021

closing due to #361 & #718 already being tracked by #514

1reaction

0x2b3bfa0commented, Jul 12, 2021

replace #cml-functions table with auto-generated collapsed command --help

Or (perhaps) better yet, move this to the new documentation engine; auto-generated, but not part of the readme.

Top Results From Across the Web

Upgrading - Snipe-IT Documentation

When available, please use the more detailed upgrade instructions for specific versions, available in the sidenav, and be sure to check out the...

Migrating from an old MySQL database - GitHub

If you need to migrate from any older version of OpenProject, upgrading multiple versions in order to get the newest version will be...

Worry-Free Business Security 9.5 Agent Readme - Trend Micro

Readme file: Contains a list of known issues and basic installation steps. It may also contain late-breaking product information not found in the...

About upgrading to 9.0 READ THIS FIRST

Upgrading Splunk Enterprise directly to version 9.0 is only supported from versions 8.1.x and higher. Upgrading a universal forwarder directly to version 9.0...

Release Notes | Avalanche Docs

Upgrade Your AvalancheGo Node. ... Miscellaneous. Added networking package README.md; Removed pagination of large db messages over gRPC; Added Size to the ...