Import: Copy editing

[amotl]

About

Just a bit of copy editing, reducing the number of "import" occurrences.

Preview

• https://crate-cloud--111.org.readthedocs.build/en/111/cluster/import.html

References

• Ingest: Canonicalize towards "data loading", also mention "import" more cratedb-guide#452

Summary by CodeRabbit

• Documentation
  • Improved clarity and organization of the import documentation
  • Enhanced section structure for easier navigation
  • Clarified supported data formats (CSV, JSON, Parquet) and compression options
  • Added concrete permission policy examples
  • Expanded guidance on globbing for importing multiple files
  • Detailed file upload handling and security information

[coderabbitai]

Walkthrough

Documentation improvements to the import guide that rewords descriptions for clarity, renames section headers (e.g., "Import from URL" → "URL"), updates code examples to JSON format, expands globbing pattern coverage, and enhances explanations of file upload security and handling.

Changes

Cohort / File(s)	Summary
Documentation updates docs/cluster/import.md	Rewording for clarity; section header renames ("Import from URL" → "URL", "Importing multiple files" → "Globbing"); JSON code fence formatting; expanded content on globbing patterns (S3-compatible storage, Azure), file upload security, compression support (CSV, JSON, Parquet), and permission guidance with concrete policy examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Verify that documentation rewording maintains technical accuracy
• Confirm section restructuring and shortened headers are logically organized
• Check that code examples (JSON, S3 policy blocks) are syntactically correct and representative

Poem

🐰 Headers trimmed, the docs now flow,
From URL to S3, all gleam and glow,
Globbing patterns dance with grace,
JSON examples find their place,
Clarity hopped through, the guide's aglow! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description is incomplete compared to the required template. While it includes a Preview section and an About section that explains the purpose of the changes, it is missing two required sections from the template: the Highlights section and the entire Checklist section, which contains important items like linking to related issues and confirming CLA signing. Additionally, the About section does not align with the template's "What's Inside" heading. These missing sections represent required template structure that should be included in a complete PR description.	The author should update the PR description to follow the required template structure. Specifically, add a Highlights section summarizing the key changes, replace "About" with "What's Inside", and complete the Checklist section with the required items: confirming a link to any related issue and verifying CLA signing status. This ensures the PR follows the repository's documentation standards and provides complete information for reviewers.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Import: Copy editing" clearly and concisely summarizes the main change in the changeset. The raw summary confirms the changeset consists entirely of documentation copy editing work on the import documentation, including rewording for clarity, section header renames, content clarifications, and formatting updates. The title directly aligns with this primary objective stated in the PR—copy editing to reduce "import" occurrences—and is specific enough for teammates scanning history to understand the change at a glance.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch import-updates

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c84a854 and 1cfd3e2.

📒 Files selected for processing (1)

• docs/cluster/import.md (4 hunks)

🔇 Additional comments (6)

docs/cluster/import.md (6)

4-11: Clear rewording that maintains readability.

The changes effectively reduce "import" repetition while preserving clarity. References to "import jobs," source/target names, and metadata provide better specificity.

---

19-19: Consistent header simplification aligned with PR objective.

Section headers are now more concise, reducing "import" repetition. While less descriptive in isolation, the body text provides sufficient context. Note: "## Globbing" (line 92) is a welcome terminology improvement over "Importing multiple files."

Also applies to: 39-39, 76-76, 92-92, 118-118

---

52-72: Well-formatted JSON policy example improves clarity.

Presenting the S3 policy as a structured JSON code block makes it more immediately useful and easier for users to adapt.

---

76-76: Minor improvements to clarity.

Path example formatting with backticks (line 84) improves code readability.

Also applies to: 84-84

---

92-115: Header and content improvements enhance technical clarity.

The terminology shift from "Importing multiple files" to "Globbing" is more precise. Enhanced description covers both S3-compatible and Azure storage options.

---

118-139: Excellent enhancement to File section.

The expanded explanation (lines 120–129) significantly improves user understanding by detailing security benefits, temporary storage behavior, deletion timeframe, and re-import capabilities. These details are valuable operational context.

---

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.}