Skip to content

S3 section, refactor code structure for readability and maintainability#317

Merged
migrau merged 4 commits intomainfrom
291-s3-access-update
Mar 4, 2026
Merged

S3 section, refactor code structure for readability and maintainability#317
migrau merged 4 commits intomainfrom
291-s3-access-update

Conversation

@migrau
Copy link
Copy Markdown
Member

@migrau migrau commented Mar 3, 2026

COPILOT GENERATED


This pull request updates the S3 storage documentation to provide users with clearer and more comprehensive instructions for accessing S3 storage on the IRB cluster. The main improvements include expanding the "How to access" section with new methods and offering step-by-step guides for each access method.

Expanded S3 Access Methods:

  • Added instructions for accessing S3 storage through the Open OnDemand web interface, including details about its read-only limitations and how to browse or download files.
  • Added a new section describing how to mount the S3 bucket as a local partition using rclone and a GUI tool, with detailed steps and screenshots.

Clarifications and Structure Improvements:

  • Updated the table of contents to reflect the new access methods: "Terminal from IRB cluster", "Open onDemand", and "Mount bucket on local".
  • Renamed the "Terminal" section to "Terminal from IRB cluster" for clarity.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR expands the IRB cluster S3 documentation to cover additional, more user-friendly access methods beyond terminal usage, including Open OnDemand browsing and mounting the bucket locally via an rclone-based GUI tool.

Changes:

  • Updated the “How to access” TOC and renamed the terminal section to “Terminal from IRB cluster”.
  • Added an “Open OnDemand” section with read-only browsing/download steps and screenshots.
  • Added a “Mount bucket on local” section with a step-by-step guide and new screenshots (s3-1..s3-5).

Reviewed changes

Copilot reviewed 1 out of 8 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
docs/Cluster_basics/s3.md Adds Open OnDemand + local mount instructions; updates TOC and terminal section title.
docs/assets/images/s3-1.png Screenshot used in local mount walkthrough.
docs/assets/images/s3-2.png Screenshot used in local mount walkthrough.
docs/assets/images/s3-4.png Screenshot used in local mount walkthrough.
docs/assets/images/s3-5.png Screenshot used in local mount walkthrough.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@migrau migrau changed the title Refactor code structure for readability and maintainability S3 section, refactor code structure for readability and maintainability Mar 3, 2026
Copilot AI review requested due to automatic review settings March 3, 2026 17:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 8 changed files in this pull request and generated 6 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 8 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@migrau migrau merged commit 1e5ce07 into main Mar 4, 2026
6 checks passed
@migrau migrau deleted the 291-s3-access-update branch March 4, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants