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

Cheaha introduction page needs rework #506

Open
wwarriner opened this issue Mar 14, 2023 · 0 comments
Open

Cheaha introduction page needs rework #506

wwarriner opened this issue Mar 14, 2023 · 0 comments
Labels
fabric: cheaha Docs related to Cheaha platform fabric: cloud.rc Docs related to cloud.rc platform fabric: k8s Docs related to Kubernetes platform fabric: storage Docs related to storage feat: article New article or section request

Comments

@wwarriner
Copy link
Contributor

What would you like to see added?

Our page at https://docs.rc.uab.edu/cheaha/getting_started/ is all over the place and hard to find information.

I think we might be better suited to have two types of introduction page for each fabric:

  1. A main intro page with the following content:
    • An introductory paragraph.
    • 3-5 common use-cases (not exhaustive).
    • A link to an introductory tutorial.
    • An list/table index of subtopics, each with a high-level, one-sentence description. These would be literal links to the pages/subsections under each fabric (e.g. Slurm).
  2. A tutorial page/subsection of pages.

A template would look like the following:

Cheaha Fabric

The Cheaha fabric is our batch processing environment used to perform large-scale computation. More sentences. More sentences. Even more sentences. No more than 1-2 short paragraphs.

How can Cheaha help me?

If your workflow matches any of the following, then Cheaha can probably help you get your research done faster.

  • List
  • Of
  • Usecases
  • One sentence each

How do I use Cheaha?

Briefly introduce and link to the tutorial.

What other features are available?

  • Slurm, our scheduler and the main interface for using Cheaha non-interactively.
  • Open OnDemand, our main interface for using Cheaha interactively.
  • Etc
  • Etc
@wwarriner wwarriner added fabric: cheaha Docs related to Cheaha platform fabric: cloud.rc Docs related to cloud.rc platform fabric: k8s Docs related to Kubernetes platform fabric: storage Docs related to storage feat: article New article or section request labels Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fabric: cheaha Docs related to Cheaha platform fabric: cloud.rc Docs related to cloud.rc platform fabric: k8s Docs related to Kubernetes platform fabric: storage Docs related to storage feat: article New article or section request
Projects
None yet
Development

No branches or pull requests

1 participant