Skip to content

Update docs based on ESRR reviewer feedback #145

@troyraen

Description

@troyraen

This list is based on the document User Support Priorities stemming from ESRR. Within each section, the tasks are listed in priority order.

  • Quick Start Guide
  • Storage Resources
  • Ingress/Egress
    • When reading the Fornax documentation, I read a strong accent on avoiding downloading large quantities of data.
    • Bulk process
    • Document how to download folders, which seems vital for downloading larger sets of data.
    • Not through AWS S3
  • Data Access
  • Environments & external software installation
    • The link to GitHub will be confusing to users since it doesn’t take them directly to where they can view the environment files. Change link to main GitHub page? -- Reorganize "Compute Environments" page #138
    • Finding and understanding the environment files would be very confusing for many users.
    • *The instructions for configuring new environments are very limited (More docs on user environments #142)
    • *Document whether the system is linux, ubuntu, Mac so users can follow prompts on external package websites (pyMultinest, mpi4py, petitRADTRANS) (More docs on user environments #142)
    • Helpdesk provided information about root access workarounds and how to save the install as a script for the future; these should be in the documentation.
    • Ran into version conflict errors when trying to install a GitHub package that used a different numpy version.
    • HPC workflows involve running scripts outside of notebooks. Can Dask be used to monitor those? Some information in scale_up.md should be represented in the documentation.
    • Comparisons between cloud read times to local disk read times were unclear.
    • Best practices for interacting with GitHub tokens (i.e. do or don’t store GitHub credentials on Fornax, use a personal access token, etc.).
  • Multilingual support
    • Include documentation on underlying technologies so that people can write non-Python code against them.
    • Resource usage
    • Clarify maximum scope of requests for additional resources.
    • Clarify how to understand one’s credit and computing usage.
  • Formatting
    • Embed code within documentation for easier access
  • Webpage
    • Link to the login page from the Fornax initiative homepage.

Metadata

Metadata

Assignees

Labels

contentdocumentation content addition or edits

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions