NiFi: Usage guide

[amotl]

About

Continue adding integration guides from the community forum.

Preview

• https://cratedb-guide--280.org.readthedocs.build/integrate/nifi/

References

• Consolidate Integration Guides I vs. II #102

[coderabbitai]

Walkthrough

Adds an Sphinx link-check ignore pattern, restructures the NiFi integration index to use an internal reference and a toctree, and introduces a new NiFi usage guide detailing step-by-step connection and ingestion examples.

Changes

Cohort / File(s)	Summary
Linkcheck configuration docs/conf.py	Appends regex r"https://s3.amazonaws.com/nyc-tlc/.*" to linkcheck_ignore with comment "Out of service."
NiFi docs index restructuring docs/integrate/nifi/index.md	Replaces external Learn link with internal ref (nifi-usage), updates card text, and adds a hidden toctree (maxdepth: 1) linking to Usage.
New NiFi usage guide docs/integrate/nifi/usage.md	Adds a detailed guide on connecting Apache NiFi to CrateDB, including prerequisites, processor configuration, CSV ingestion, SQL snippets, and cross-database example.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Integrate/Kafka: Rework section. Add Python tutorial. #263 — Also updates docs/conf.py by appending linkcheck ignore patterns.
• ETL/CDC: Balancing, Layout / Visual and structural overhaul for individual "Integration" pages #241 — Touches NiFi integration docs and docs/conf.py, overlapping with index restructuring and linkcheck settings.
• Remove page-local TOC #217 — Modifies the same linkcheck_ignore list with additional URL patterns.

Suggested labels

new content, guidance, cross linking

Suggested reviewers

• kneth
• karynzv

Poem

A nibble of links, a hop through NiFi lanes,
I twirl my ears at toctrees and tidy chains.
New paths to CrateDB, carrots queued in rows—
CSVs to tables, watch the data flows.
With whiskered wisdom, I stamp and cheer:
“Docs aligned—now follow me here!” 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "NiFi: Usage guide" concisely and accurately summarizes the main change in this PR by indicating the addition of a usage guide for NiFi integration. It uses clear, specific language without extraneous details, avoiding vague terms like "misc updates." This phrasing ensures that teammates scanning the repository history immediately understand the primary change being introduced.
Description Check	✅ Passed	The pull request description directly relates to the integration guides being added and provides context for the change by stating that community forum guides are being continued. It includes a preview link showing the updated NiFi documentation and references the associated GitHub issue for traceability. Thus, it is on-topic and adequately communicates the purpose of the PR.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch nifi

---

📜 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 8bf1d05 and 5abfc82.

📒 Files selected for processing (3)

• docs/conf.py (1 hunks)
• docs/integrate/nifi/index.md (2 hunks)
• docs/integrate/nifi/usage.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/integrate/nifi/usage.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/integrate/nifi/index.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

🔇 Additional comments (1)

docs/conf.py (1)

80-81: LGTM! Appropriate link-check exclusion.

The addition of the NYC TLC S3 bucket to the ignore list is appropriate given the "Out of service" comment. This prevents CI failures from checking unavailable external resources.

---

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

🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

• Public repositories are always opted into early access features.
• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

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

[amotl]

@coderabbitai: review and convert to active voice, please.