-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
contentdocumentation content addition or editsdocumentation content addition or edits
Description
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
- *Is the platform meant to support HPC workflows, given automatic timeouts and other factors?
- Simple instructions for copying and editing notebooks
- *What is a “work session”? -- Update shutdown and logout instructions in quick_start.md #136
- Will my work and environment be lost if I step away from my computer leaving the window open? -- Simple fixups from ESRR reviewer feedback #152
- What does shutting down a server do? Does it deconstruct the container? -- Simple fixups from ESRR reviewer feedback #152
- What happens if I don’t shut it down? (Mostly answered in “Server and Environment Options”) -- Simple fixups from ESRR reviewer feedback #152
- Keep-alive option for the kernel should be here, because it causes a lot of headaches -- Simple fixups from ESRR reviewer feedback #152
- *Document manual process for changing email or password. If a user needs to make a change to the password, they should email, their password will be reset and sent to them via email. Then they login and change it.
- Storage Resources
- *Include a full description of the default directories and what they are used for (fornax-notebooks, lost+found, pfiles, s3-storage, shared-storage).
- Describe which directories users can modify files and keep the modifications
- Related issues:
- 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
- *Need more guidance for how to interact with data archives
- Need link to better documentation for s3fs -- Simple fixups from ESRR reviewer feedback #152
- Include examples.
- 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 editsdocumentation content addition or edits