Update the ftp docs#504
Open
KavinduZoysa wants to merge 2 commits into
Open
Conversation
KavinduZoysa
requested review from
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThis PR restructures Visual Designer FTP, FTPS, and SFTP walkthroughs by converting inline procedural steps into structured listener and authentication tables, clarifying certificate/private-key guidance, and renumbering monitoring-path and Add File Handler steps. ChangesFTP/FTPS/SFTP Integration Walkthroughs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/develop/integration-artifacts/file/ftp-sftp.md`:
- Line 36: Three markdown table rows in the listener configuration tables are
missing the trailing pipe character: the "Protocol" row in the FTP section (the
diff line containing "| **Protocol** | Types of protocol. Select `ftp`."), and
the corresponding rows in the FTPS and SFTP sections; fix each by appending a
trailing pipe character "|" at the end of those lines so they become valid table
rows.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 493a6ead-ec58-4f2b-904a-48e9506bc46d
📒 Files selected for processing (1)
en/docs/develop/integration-artifacts/file/ftp-sftp.md
KavinduZoysa
force-pushed
the
update-ftp-docs
branch
from
1fc4ade to
07f263a
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
en/docs/develop/integration-artifacts/file/ftp-sftp.md (1)
224-224: 💤 Low valueConsider aligning the authentication step wording with FTP/FTPS pattern.
The SFTP authentication step reads "Choose Certificate-Based Authentication under authentication method" which directly instructs the user to select a specific option. In contrast, the FTP (line 42) and FTPS (line 134) sections use "Choose an authentication method:" followed by a table showing available options.
While the Visual Designer may only expose certificate-based authentication for SFTP (with password auth requiring the Ballerina Code tab per line 206), consider rewording for consistency:
4. The **authentication method** is set to **Certificate-Based Authentication**. This reveals the **Private Key** and **Username** fields.Or maintain the existing pattern but clarify it's the default/only UI option:
4. For **authentication method**, the Visual Designer uses **Certificate-Based Authentication**. This reveals the **Private Key** and **Username** fields.This minor adjustment would align the presentation style across all three protocol walkthroughs.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/develop/integration-artifacts/file/ftp-sftp.md` at line 224, Edit the SFTP authentication step text so it matches the wording pattern used for FTP/FTPS: replace "Choose **Certificate-Based Authentication** under **authentication method**. This reveals the **Private Key** and **Username** fields." with a phrasing like "The **authentication method** is set to **Certificate-Based Authentication**. This reveals the **Private Key** and **Username** fields." or "For **authentication method**, the Visual Designer uses **Certificate-Based Authentication**. This reveals the **Private Key** and **Username** fields." to maintain consistent presentation across FTP/FTPS/SFTP sections.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/develop/integration-artifacts/file/ftp-sftp.md`:
- Line 36: Replace the plural phrase "Types of protocol" with the singular "Type
of protocol" in the three table cells that describe the protocol selection
(currently reading "Types of protocol") so each listener correctly states one
protocol type; update the occurrences in the FTP, FTPS and SFTP sections by
finding the table cell text "Types of protocol" and changing it to "Type of
protocol".
---
Nitpick comments:
In `@en/docs/develop/integration-artifacts/file/ftp-sftp.md`:
- Line 224: Edit the SFTP authentication step text so it matches the wording
pattern used for FTP/FTPS: replace "Choose **Certificate-Based Authentication**
under **authentication method**. This reveals the **Private Key** and
**Username** fields." with a phrasing like "The **authentication method** is set
to **Certificate-Based Authentication**. This reveals the **Private Key** and
**Username** fields." or "For **authentication method**, the Visual Designer
uses **Certificate-Based Authentication**. This reveals the **Private Key** and
**Username** fields." to maintain consistent presentation across FTP/FTPS/SFTP
sections.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 310484d8-1b46-41bb-80d3-7f7c09f4baa1
📒 Files selected for processing (1)
en/docs/develop/integration-artifacts/file/ftp-sftp.md
| # CSV Fault Tolerance | ||
|
|
||
| Real-world CSV files rarely arrive perfectly clean. A single bad row (a stray comma, a wrong data type, a trailing blank) would normally fail the whole file. With **CSV fault tolerance** enabled, the listener treats malformed rows as a per-row issue instead of a per-file one. It skips rows that don't fit your schema and hands the rest to the handler as if nothing happened. | ||
| Real-world CSV files rarely arrive perfectly clean. A single bad row (a stray comma, a wrong data type, a trailing blank) would normally fail the whole file. With **Csv Fail Safe** enabled, the listener treats malformed rows as a per-row issue instead of a per-file one. It skips rows that don't fit your schema and hands the rest to the handler as if nothing happened. |
Contributor
There was a problem hiding this comment.
Should this be CSV Fail Safe?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
$subject
Summary by CodeRabbit