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

Turn prerequisites in one single paragraph #807

Open
1 task
atteggiani opened this issue Sep 23, 2024 · 0 comments
Open
1 task

Turn prerequisites in one single paragraph #807

atteggiani opened this issue Sep 23, 2024 · 0 comments
Assignees
Labels
💄code quality Improvements to the code quality or readability ✏️ documentation Improvements or additions to documentation

Comments

@atteggiani
Copy link
Contributor

Description

Currently, in the "how to run ..." pages the "Prerequisites" paragraph has 2 sub-paragraphs:

  • General prerequisites (always the same for all models)
  • Model-specific prerequisites

I suggest joining the "General prerequisites" and "Model-specific prerequisites" sub-paragraphs into one single paragraph called "Prerequisites".

This simplifies the text and list the prerequisites all in one condensed paragraph.

For the How to run ACCESS-OM page, for example, the new "Prerequisites" paragraph would look something like:


Prerequisites

  • NCI Account
    Before running ACCESS-OM2, you need to Set Up your NCI Account.
  • Join the vk83 and qv56 projects at NCI
    To join these projects, request membership on the respective vk83 and qv56 NCI project pages.
    For more information on joining specific NCI projects, refer to How to connect to a project.
  • Payu
    Payu is a workflow management tool for running numerical models in supercomputing environments, for which there is extensive documentation.
    ...
    ...

Close Criteria

  • Make prerequisites in "How to run a model" pages all in one single top-level "Prerequisites" paragraph.
@atteggiani atteggiani added ✏️ documentation Improvements or additions to documentation 💄code quality Improvements to the code quality or readability labels Sep 23, 2024
@atteggiani atteggiani self-assigned this Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💄code quality Improvements to the code quality or readability ✏️ documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant