Import: Use less "Import"

[amotl]

About

The "Import" page pulls all the attention, so the new canonical pages within CrateDB Guide have no chance to provide better guidance.

Summary by CodeRabbit

• Documentation
  • Reorganized import documentation with simplified section headings for improved navigation.
  • Enhanced content with expanded details on import limits, permissions, file formats, and metadata fields.
  • Reformatted code examples and JSON blocks for improved clarity and readability.

[coderabbitai]

Walkthrough

Documentation update to Import guidance refactoring section headings to be more concise (e.g., "Import from URL" → "URL"), simplifying language throughout, reformatting code examples into dedicated blocks, and expanding descriptions of import methods and metadata fields.

Changes

Cohort / File(s)

Summary

Import documentation restructuring docs/cluster/import.md

Section headings simplified (e.g., "Import from URL" → "URL", "Import from private S3 bucket" → "S3 bucket", "Importing multiple files" → "Globbing", "Import from file" → "File"); wording refined throughout (e.g., "It's important to" → "It is important to"); code examples reformatted with dedicated JSON blocks; content expanded to include source/target metadata, permissions details, and file size limits

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Primarily cosmetic restructuring of section headings and documentation rewording
• Code examples reformatted for consistency rather than logic changes
• No functional or code-level impact

Possibly related PRs

• Import: Copy editing #111: Overlapping structural and copy-editing changes to the same import documentation file, including heading renames and example reformatting.

Poem

📚 A rabbit's ode to clearer docs,
Where "Import from URL" now simply rocks,
Headings trimmed like carrots neat,
Examples formatted, oh so sweet! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description does not follow the required template structure. The provided description only includes an "## About" section with context and a screenshot, but it is missing all four required sections from the template: "## What's Inside", "## Preview", "## Highlights", and the "## Checklist" (which includes important items like CLA signing confirmation and issue linking). While the author provided some motivation for the change and supplementary context with an image, the description is largely incomplete compared to the required structure.	The author should update the PR description to include all required template sections. At minimum, add the "## Checklist" section with the required items (issue reference and CLA confirmation), and populate "## What's Inside", "## Preview", and "## Highlights" sections with appropriate details about the documentation changes. The existing context and screenshot can be incorporated into the relevant sections as needed.
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 title "Import: Use less 'Import'" directly and clearly reflects the main changes in the pull request. The raw summary confirms that the documentation has been updated with renamed sections that reduce redundant use of the word "Import" — for example, "## Import from URL" is now "## URL", "## Import from Azure Blob Storage Container" is now "## Azure Blob Storage", and similar reductions throughout. The title is concise, specific, and clearly communicates the primary change without being vague or generic.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

📜 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 9f984ec and bcf97ef.

📒 Files selected for processing (1)

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

🔇 Additional comments (4)

docs/cluster/import.md (4)

4-11: Address vague phrasing and verify text alignment with PR objectives.

Line 11 uses generic "the page" which is less specific than the original context—consider clarifying whether this refers to an import form, dialog, or specific interface element. Additionally, the AI-generated summary indicates that "Show details" navigation phrasing should change to reference "import job" details, but line 8 still shows the old phrasing. Verify whether this update was intentional or needs to be completed.

---

19-19: Heading simplifications are well-executed and maintain backward compatibility.

The consistent reduction of "Import" from section headings (e.g., "Import from URL" → "URL") effectively achieves the PR objective while preserving anchor IDs (cluster-import-*) for backward compatibility with existing links and cross-references.

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

---

53-53: Grammar and formatting improvements enhance documentation quality.

The change from "It's important to" to "It is important to" improves formality consistency in documentation. The JSON policy example now uses proper markdown code block syntax with language identifier for better syntax highlighting and readability.

Also applies to: 57-72

---

84-84: Clear inline code formatting for path examples.

The path format now uses inline code, improving clarity and visual distinction between literal paths and explanatory text.

---

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