Skip to content

Add Charliecloud docs, git-revision-date plugin, and various updates#244

Open
pnsinha wants to merge 2 commits intomainfrom
pns_python
Open

Add Charliecloud docs, git-revision-date plugin, and various updates#244
pnsinha wants to merge 2 commits intomainfrom
pns_python

Conversation

@pnsinha
Copy link
Copy Markdown
Collaborator

@pnsinha pnsinha commented Feb 12, 2026

Summary

  • Add Charliecloud documentation with storage and cache configuration guidance
  • Add mkdocs-git-revision-date-localized-plugin to show last updated dates on pages

@pnsinha pnsinha requested review from vadim-cherepanov and removed request for vadim-cherepanov February 12, 2026 22:12
@pnsinha pnsinha marked this pull request as draft February 14, 2026 19:13
@pnsinha pnsinha marked this pull request as ready for review February 16, 2026 20:21
Copy link
Copy Markdown
Collaborator

@vadim-cherepanov vadim-cherepanov left a comment

Choose a reason for hiding this comment

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

All good! I had some problems with a few commands (worked without the docker:// part), where the images are stored, and mounting. A few other minor suggestions as well.

Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread docs/software/apps-and-envs/charliecloud.md
Comment thread docs/software/apps-and-envs/charliecloud.md Outdated
Comment thread mkdocs.yml
@ndtrung81
Copy link
Copy Markdown
Collaborator

@pnsinha could you please address @vadim-cherepanov reviews so that we can merge the PR?

- Remove invalid docker:// prefix from ch-image pull and ch-convert
- Fix storage path from ~/.charliecloud/ to /var/tmp/pnsinha.ch/img/
- Use image names instead of full paths for ch-run commands
- Fix bind mount destinations to use existing /mnt/0-9 mount points
- Add warning about bind mount destination requirement
- Document CH_IMAGE_STORAGE and -s flag for custom storage
- Reorder best practices (bind mounts before host MPI)
- Update docs link to charliecloud.io/latest/
- Note git-revision-date-localized-plugin pip dependency in mkdocs.yml

Addresses review feedback from PR #244.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants