Skip to content

Refactor code structure for readability and maintainability#318

Merged
migrau merged 1 commit intomainfrom
s3-update-access
Mar 5, 2026
Merged

Refactor code structure for readability and maintainability#318
migrau merged 1 commit intomainfrom
s3-update-access

Conversation

@migrau
Copy link
Member

@migrau migrau commented Mar 5, 2026

COPILOT GENERATED

This pull request updates the S3 documentation to clarify access methods and improve instructions for users. The changes emphasize the distinction between read and write access, provide clearer steps for credential management, and enhance navigation instructions for Open OnDemand and local mounting.

Access and permissions clarification:

  • Updated the documentation to specify that write access to S3 is only available via the terminal, while read access (such as browsing and reading files) can be done through Open OnDemand or by mounting the bucket locally.

Credential management and navigation improvements:

  • Added instructions to verify or create S3 credentials in Open OnDemand, including a new screenshot to guide users.
  • Improved the navigation steps for accessing S3 storage in Open OnDemand, clarifying the sequence and updating section names for better usability.
  • Clarified the section and anchor naming for mounting S3 buckets locally, and updated related references throughout the document. [1] [2]

Mounting instructions update:

  • Fixed the formatting of the rclone mount command output in the local mounting example for better clarity.

Copilot AI review requested due to automatic review settings March 5, 2026 15:06
Copy link
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 updates the S3 documentation to clarify how users can access S3 (distinguishing read-only browsing from write-capable workflows) and adds Open OnDemand credential guidance with a new screenshot.

Changes:

  • Clarifies that write-capable access is via terminal, while read-only browsing is possible via Open OnDemand or local mounting.
  • Adds an Open OnDemand credential verification/renewal step and a new supporting screenshot.
  • Adjusts local-mount section heading/anchors and tweaks the rclone mount example formatting.

Reviewed changes

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

File Description
docs/Cluster_basics/s3.md Updates access-method guidance, adds Open OnDemand credential step + image, and updates anchors/formatting.
docs/assets/images/s3-ooo-credentials.png Adds a new screenshot referenced by the Open OnDemand section.

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

@migrau migrau merged commit 9152fa7 into main Mar 5, 2026
4 of 6 checks passed
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