Skip to content

Reorganize information on the computing resources and software environments #129

@DavidT3

Description

@DavidT3

Pretending to be a new user again (not that difficult given I only started a few weeks ago), I think that the information regarding what computing resources and software environments are available should be re-organized. There is some small amount of replication, and some information missing that you might expect based on the title of the docs section (for instance the actual quantification of computing resource options, listing CPU and memory) is in the section labelled (in the menu on the left of the docs) 'Fornax Science Console Capabilities', and not in 'Server and Environment Options'.

The 'Server and Environment Options' text does link back to the specific definition of what resources are available to each compute option, but I think it would make more sense the other way around.

My thoughts:

  1. We merge the 'Fornax User Documentation' landing page and the 'Fornax Science Console Capabilities' pages into a combined landing page, and cut down the 'Computing Resources' section to be one line summaries rather than specifics (e.g. simply state there are several options of compute scale available, and direct them to a whole section dedicated to that information for specifics). I think merging those two overall sections make sense, as they are doing quite similar things - introducing what Fornax is and why it exists.
  2. Change the 'Server and Environment Options' section to 'Choosing a Server' or some such thing, and focus just on the compute choices, possibly including the storage information as well. Remove the description of software environments other than a segue to the 'compute environments' section, which should follow immediately after the section discussing compute options.
  3. This software environments section first discusses the choices of image - default astro vs high energy astro - and from there naturally branches into discussion of what software are available within each image.

I think this consolidation is important, because in my opinion users are more likely to look for the category of information they want in the sections ToC on the left, rather than reading through all the pages carefully and sequentially.

I am going to start working on this, I think it'll be easier to communicate what I mean by just demonstrating it, and also from the HEASARC point of view we need to get better/any descriptions of how to use the high-energy software conda environments into these docs before the ESRR starts in earnest.

Sub-issues

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