Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure execution mode pages #2133

Open
1 of 5 tasks
jyu00 opened this issue Oct 14, 2024 · 0 comments
Open
1 of 5 tasks

Restructure execution mode pages #2133

jyu00 opened this issue Oct 14, 2024 · 0 comments

Comments

@jyu00
Copy link
Collaborator

jyu00 commented Oct 14, 2024

URL to the relevant documentation

No response

Select all that apply

  • typo
  • code bug
  • out-of-date content
  • broken link
  • other

Describe the fix.

While reviewing #2105, I had some ideas on how we can restructure the execution modes pages. I'm opening a new issue instead of commenting in the PR in case we want to merge the PR first.

Introduction to execution modes

  1. First introduce what execution modes are. The one liner we have today "There are several ways to run workloads", IMHO, isn't enough introduction. It should instead mention what execution modes and why one should care. For example, the execution modes indicate how your jobs are to be scheduled, and choosing the right execution mode allows your jobs to run efficiently within the time budget you have.
  2. Then it can go into a brief introduction on what modes we have and what each does
  3. Then the concepts of active, max, and iTTL. These apply to both session and batch. Much of the existing "Introduction to session" can merged in here.

Choosing the right execution mode

  1. Some introduction on things to consider, such as usage, overall execution time, iTTL requirement, and time in between jobs
  2. Explain what usage means (e.g. it reduces your priority)
  3. Give recommendation, including best practices
  4. Give some examples - e.g. what should you expect when running an iterative workload using session vs batch vs job

Run jobs in a session/batch

These pages would focus on code examples. Things like why you should use batch, which is currently mentioned in the Run.. page, should be moved to the Choosing... page.

@jyu00 jyu00 added bug 🐛 content 📄 needs triage 🤔 this issue needs to be prioritized by the docs team labels Oct 14, 2024
@jyu00 jyu00 removed the bug 🐛 label Oct 14, 2024
@javabster javabster added needs discussion 💬 and removed needs triage 🤔 this issue needs to be prioritized by the docs team labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

5 participants