Start: Improve guidance for data import / ingest / load

[amotl]

About

Better naming things for improved user guidance, accommodating Algolia search, and a better visual representation of guiding elements. Please advise if you think differently.

Preview

• https://cratedb-guide--461.org.readthedocs.build/start/import.html

References

• Ingest: Canonicalize towards "data loading", also mention "import" more #452
• Import: Copy editing cloud-docs#111

[coderabbitai]

Walkthrough

Documentation terminology and structure updated across two files to align with "import" language instead of "ingest." The import guide header and navigation entry renamed, and card component restructured with styling adjustments and button element additions.

Changes

Cohort / File(s)	Change Summary
Documentation terminology alignment docs/start/import.md, docs/start/index.md	Header changed from "Ingesting data" to "Importing data"; navigation toctree entry updated from "ingest" to "import"; documentation anchors added; card component restructured with width/margin styling and button-ref block; content text refined for consistency

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation-only changes with consistent terminology alignment pattern
• Verify RST/Sphinx card component syntax and styling correctness in docs/start/import.md
• Confirm navigation cross-references remain valid after toctree relabeling

Possibly related PRs

• Getting started: Rework whole section #232: Modifies the same start/index.md toctree and adjusts the "ingesting data" navigation entry, indicating ongoing terminology alignment work.
• Ingest: Canonicalize towards "data loading", also mention "import" more #452: Makes corresponding documentation terminology changes shifting from "ingest" toward "import"/"load" language across the guide.

Suggested labels

cross linking

Suggested reviewers

• kneth
• karynzv
• surister

Poem

🐰 From ingest to import, words dance and play,
The rabbit rewrites docs in its own whimsical way,
Cards styled and buttoned with care so divine,
Cross-links now harmonize, perfectly aligned! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
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 (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "Start: Improve guidance for data import / ingest / load" is directly related to the main changes in the changeset. The raw summary shows that the PR renames documentation sections from "ingest" terminology to "import" and restructures related content in the "start" documentation area. The title clearly and specifically captures this primary change—improving guidance by refining the naming and terminology around data import/ingest/load operations. The title is concise, avoids vague language, and provides sufficient context for understanding the changeset's purpose.
Description Check	✅ Passed	The pull request description is related to the changeset in multiple ways. The description mentions "better naming things for improved user guidance," which directly corresponds to the changes renaming terminology from "ingest" to "import" in both the documentation file and navigation structure. The reference to "better visual representation of guiding elements" aligns with the restructuring of the card section to include enhanced styling and button elements. The description also provides context about the intent (accommodating Algolia search, improving guidance) and includes references to related issues and a preview link, demonstrating that the author has documented the purpose and impact of these changes.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

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

---

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

[bmunkholm]

@amotl If we think "Import" is a better word, shouldn't that also be reflected here and in line 45?

[amotl]

Probieren geht über studieren. We are testing how Algolia presents corresponding search requests, and will also check Google and friends.

[bmunkholm]

Ok - then perhaps both is good 👍