AIS Documentation Structure

[RyanPSullivan7]

The current AIS documentation is scattergun on contributions. We need to change into a more structured hierachy as part of our website redesign. We are seeking feedback on structure.

Researchers

• Getting Started
• User Setup
• Project Setup
• Uploading Data
• Manageing Data
• Container Pipelines
• Virtual Desktops
• External Systems
  -- HPC
  -- REDCap
  -- Galaxy

Facilities

• New Uploader
  -- Vendor Configurations
• Clinical Trials Process (CTP)

Node Administration

• XNAT Config (not covered by Helm)
• XNAT Admin Roles
  -- Managing Containers
  -- Managing Jupyter
• Reporting

Technical Documentation

AIS Node

• Quickstart & Requirements
• XNAT
  -- AAF
• PostgreSQL
• CTP
• ...Other core application services in AIS chart orchestration and user experience discussion #173...

AIS Edge

• Quickstart & Requirements

Kubernetes Options

• AWS EKS
• ARDC NECTAR

Development

• Local Setup
• CICD

[RyanPSullivan7]

@aswinnarayanan @markendr @tclose @fxusyd @dean-taylor @davidpoger @arkiev @craigwindell @franksc @szho42 Please add any comments or thoughts

[anzhao]

Added the "Researchers" section to the doc site: https://australian-imaging-service.github.io/web-dev/docs/researchers/

[anzhao]

Added the "Facilities" section to the doc site: https://australian-imaging-service.github.io/web-dev/docs/facilities/

[RyanPSullivan7]

I see the order has defaulted to alphabetical? It needs to match the order I put above.

[anzhao]

The order has been changed to "Researchers" first , "Facilities" second, "Node Administration" third ....

[RyanPSullivan7]

Thanks. Could you fix the second level of nesting as well? i.e. Getting Started should be the first under Researchers

[anzhao]

No probelm Ryan and thank you for let me know.

[anzhao]

Fixed second level of nesting as well as the third level, and they are in the order specified, see attached.

[anzhao]

Added the "Node Administration" section to the doc site: https://australian-imaging-service.github.io/web-dev/docs/node-administraton/

[anzhao]

The User documentation has been taken out from the AIS doc structure as required.

[anzhao]

Added the "Technical Documentation" section to the doc site: https://australian-imaging-service.github.io/web-dev/docs/technical-documentation/ and sort the second level and third level side menu according to the requirments.

[anzhao]

Expand the AIS Node to include JupyterHub, CVMFS Client, OpenCost, Prometheus, K8s Cron Jobs and Globus as addressed in issue #173.

[anzhao]

Creating the content of "Getting Started" page: https://australian-imaging-service.github.io/web-dev/docs/researchers/getting-started/