Skip to content

Update Freezer docs #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Oct 1, 2025
Merged

Update Freezer docs #789

merged 5 commits into from
Oct 1, 2025

Conversation

AgentKumara
Copy link
Collaborator

No description provided.

@gemini-code-assist Gemini Code Assist
Copy link
Contributor

Summary of Changes

Hello @AgentKumara, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the Freezer long-term storage documentation by reorganizing existing content and introducing new, dedicated guides. The changes aim to improve clarity and user experience by separating configuration, usage, advanced commands, and troubleshooting into distinct, easily navigable sections. This restructuring makes it simpler for users to find specific information related to interacting with Freezer via s3cmd.

Highlights

  • Documentation Restructuring: The Freezer long-term storage documentation has been significantly reorganized, breaking down a large, monolithic guide into several focused pages for improved clarity and navigation.
  • New s3cmd Configuration Guide: A dedicated guide, 'Configuring_s3cmd.md', has been added to provide step-by-step instructions for setting up the s3cmd tool, including details on access keys, endpoints, and other critical parameters.
  • Comprehensive Freezer Usage Guide: A new 'Freezer_Guide.md' now covers core s3cmd operations such as listing bucket contents, checking storage usage, uploading files and folders, and restoring data from tape (Glacier storage).
  • Additional s3cmd Commands: A new page, 'Other_Useful_Commands.md', consolidates information on compressing files, managing large files with chunk sizes, moving, copying, and safely deleting data within Freezer.
  • Troubleshooting Guide: A new 'Troubleshooting.md' document addresses common issues users might encounter, offering solutions for long transfer times (using tmux), incorrect secret keys, and configuration errors due to whitespace.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Docs now clear and bright, Freezer's secrets brought to light, Data flows with ease.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@AgentKumara AgentKumara requested a review from clairerye October 1, 2025 20:46
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2025

Test deployment available at https://callumwalley.github.io/mkdocs-demo-deploy/nesi/support-docs/freezer

Seems the following pages differ;



See all deployed demo sites

clairerye
clairerye reviewed Oct 1, 2025
View reviewed changes
Copy link
Contributor

@clairerye clairerye left a comment

Choose a reason for hiding this comment

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

looks good, a few comments.

I think the big one for consistency is that all the <freezer_bucket> should be

docs/Storage/Long_Term_Storage/Configuring_s3cmd.md Outdated
You will need to configure the `s3cmd` tool before you use it for the first time. Configuring the `s3cmd` allows for user credentials and default buckets to be remembered. This will only need to be done once.

```sh
s3cmd --configure --multipart-chunk-size-mb=1024
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should be

s3cmd --configure

docs/Storage/Long_Term_Storage/Freezer_Guide.md
List all objects in a bucket.

```sh
s3cmd ls -r -l -H s3://<freezer_bucket>/
Copy link
Contributor

Choose a reason for hiding this comment

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

lets remove _ as we cannot use _ in bucket names any more, can we make it ?

docs/Storage/Long_Term_Storage/Freezer_Guide.md
s3cmd du -H s3://<freezer_bucket>
7G 1781 objects s3://<freezer_bucket>/
```

Copy link
Contributor

Choose a reason for hiding this comment

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

again switch _ for -

docs/Storage/Long_Term_Storage/Freezer_Guide.md

```sh
s3cmd put --verbose your_file s3://<freezer_bucket>/your_directory/your_file
```
Copy link
Contributor

Choose a reason for hiding this comment

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

_ to - in bucket

@AgentKumara
Update Configuring_s3cmd.md
fae91a5 
fixed s3cmd --configure

Signed-off-by: Vicky Fan <[email protected]>
@AgentKumara
Update Freezer_Guide.md
b05d0d3 
Signed-off-by: Vicky Fan <[email protected]>
@AgentKumara
Update Freezer_long_term_storage.md
6ae7cb5 
Signed-off-by: Vicky Fan <[email protected]>
@AgentKumara
Update Other_Useful_Commands.md
4a7e8d4 
Signed-off-by: Vicky Fan <[email protected]>
@AgentKumara AgentKumara merged commit aec35cf into main Oct 1, 2025
8 checks passed
@AgentKumara AgentKumara deleted the freezer branch October 1, 2025 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@clairerye clairerye clairerye left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AgentKumara @clairerye