search

flux-framework / flux-k8s

Project to manage Flux tasks needed to standardize kubernetes HPC scheduling interfaces
Apache License 2.0
20 stars 10 forks source link

Update README and replace old examples #38

Closed milroy closed 1 year ago

milroy commented 1 year ago

The current README and examples are dated and confusing to users. This PR updates the documentation and adds links and paper references.

milroy commented 1 year ago

This PR address issue #38 . @cmisale it would be good to have you input on this PR, especially whether we need to retain any of the old examples, or if we need to include instructions for a Helm install of Fluence.

cmisale commented 1 year ago

@milroy (@kannon92) if the pi example work, it's a good idea to keep it. It's good to have a backup example for who doesn't want to run the entire CORAL benchmarks. Give me a few hours to review the installation process so I can figure out better what to add

milroy commented 1 year ago

Yes, I'll keep the pi example, especially since it works easily with kind. Thanks @kannon92! I'll also wait for your additional feedback @cmisale.

milroy commented 1 year ago

Alright, I finally implemented your suggestions @kannon92 and @cmisale. Let me know if there's more to do.

cmisale commented 1 year ago

That looks great! So excited to have actual documentation lol