Skip to content

Conversation

@2bPro
Copy link

@2bPro 2bPro commented Jan 6, 2026

EIDF Documentation Pull Request

Description

  • Extended the Overview page to add roles and responsibilities and contact sections
  • Collapsed Network Access Controls, Safe Haven Access, and Virtual Desktop connections into a single page called "Access" and de-duplicated information
  • Added a Software Management page containing information about available software, system maintenance, and guide for managing R packages post-maintenance (SHS board ticket). This document was also added to its own branch (bp/maintenance-docs) in case the rest of the changes are not acceptable.
  • Removed the "Using the HPC Cluster" page from the navigation as most of the information was duplicated on "Accessing the SDF Inside the EPCC TRE" page.
  • Renamed the "Superdome Flex Tutorial" navigation section to "HPC Service".
  • Renamed the "TRE Container User Guide" navigation section to "Container Service"

Type of change

Please delete options that are not relevant.

  • Incorrect Documentation
  • Incomplete Documentation
  • Missing Documentation
  • Formatting
  • New Documentation

What has to be reviewed

SHS documentation.

Checklist

  • Documentation follows the project style guidelines
  • Ensure Contact details contain Service Emails and Numbers
  • Self-review of documentation using mkdocs on local system
  • Spellcheck has been performed
  • Pre-commit has been run and passed

@2bPro 2bPro requested a review from kavousan January 6, 2026 15:43
@2bPro 2bPro self-assigned this Jan 6, 2026
@2bPro 2bPro added the documentation Improvements or additions to documentation label Jan 6, 2026
Copy link
Contributor

@kavousan kavousan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for drafting; sorry I took so very long...

bprodan added 2 commits January 30, 2026 14:35
* Rename TRE to SHS accross the documentation - some instances such as external URLs to repos or proxy had to be retained. OOD and GPU docs have been duplicated with these changes because they are hidden and currently circulating TRE URLs
* Rename SDF to SDFlex
* Change EIDF -> EPCC SHS
@2bPro
Copy link
Author

2bPro commented Jan 30, 2026

Hidden pages:

@2bPro 2bPro requested a review from kavousan January 30, 2026 14:53
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this file, URLs seems to have changed from tre to shs; is this correct?

Copy link
Contributor

@kavousan kavousan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all this work!

I asked a question on mkdocs.yml.

But what concerns me is that there are GPU and OOD and database files in this PR, that I don't think were in the previous one. What is the correct thing to do?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants