Refactor code structure for readability and maintainability#318
Merged
Conversation
Contributor
There was a problem hiding this comment.
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 mountexample 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Credential management and navigation improvements:
Mounting instructions update:
rclone mountcommand output in the local mounting example for better clarity.