Document pre-compiled image usage with CVMFS

[anigamova]

Added instructions for using pre-compiled container images with CVMFS dependency and Apptainer.

Summary by CodeRabbit

• Documentation
  • Added instructions for using a pre-compiled container image with CVMFS support, including commands for pulling and running the image
  • Provided environment configuration guidance for running the tool within a container
  • Added note that batch submission is not supported with this container setup

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This pull request adds documentation for a pre-compiled container image with CVMFS dependency support. The new content includes instructions for pulling and running an Apptainer container, environment setup guidance, and notes that batch submission is not supported with this configuration. The additions appear twice in the document.

Changes

Cohort / File(s)	Summary
CVMFS Container Documentation docs/index.md	Adds two nearly identical sections describing a pre-compiled image with CVMFS dependency, including Apptainer/Oracle commands, container setup instructions, and environment configuration guidance

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

• Attention needed: Verify whether the duplicate section additions are intentional or if one should be removed/consolidated; clarify the intended placement and purpose of each block
• Consideration: Review the accuracy of Apptainer commands and CVMFS setup instructions for correctness

Possibly related PRs

• Update docs for standalone compilation with LCG #1148: Adds or duplicates pre-built container/Docker guidance in docs/index.md; similar documentation expansion for containerized setups

Poem

🐰 A doc update hops into view,
With containers and CVMFS too!
Two blocks take their place,
In documentation space—
New setup paths for reviewers to brew! 📦

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding documentation for pre-compiled image usage with CVMFS.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch anigamova-patch-8

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3956794 and 076cc77.

📒 Files selected for processing (1)

• docs/index.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/index.md

217-217: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (2)

docs/index.md (2)

198-220: Documentation content looks clear and well-structured.

The new section provides helpful instructions for users with CVMFS access, including Apptainer setup, environment initialization, and an important note about batch submission limitations. The placement after the conda-based standalone instructions and before Docker alternatives is logical.

---

198-220: No duplication detected—this section appears only once in the document.

The verification found only a single occurrence of the "Pre-compiled image with CVMFS dependency" section at line 198, the Apptainer command at line 204, and the environment source line at line 218. No maintenance burden or inconsistency risks from duplication exist.

Likely an incorrect or invalid review comment.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add language specifier to fenced code block.

Line 217 lacks a language identifier for the code block. This violates the MD040 markdown linting rule and makes the code block less readable for syntax highlighting.

Apply this diff to fix the linting violation:

 Alternatively, you can set up Combine with a single-line command which relies on the same image:
 
-```
+```shell
 source /cvmfs/cms.cern.ch/cat/combine_env.sh
-```
+```

🧰 Tools

🪛 markdownlint-cli2 (0.18.1)

217-217: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents

In docs/index.md around lines 217 to 219, the fenced code block is missing a
language specifier (causing MD040 lint errors); update the opening backticks to
include "shell" so the block begins with ```shell and leave the rest unchanged
to enable proper syntax highlighting and satisfy the linter.