Skip to content

Fix link formatting in FTP/SFTP documentation#472

Merged
LakshanWeerasinghe merged 1 commit into
wso2:mainfrom
YasanPunch:ftp-broken-link-fix
May 18, 2026
Merged

Fix link formatting in FTP/SFTP documentation#472
LakshanWeerasinghe merged 1 commit into
wso2:mainfrom
YasanPunch:ftp-broken-link-fix

Conversation

@YasanPunch

@YasanPunch YasanPunch commented May 18, 2026

Copy link
Copy Markdown
Contributor

Purpose

Fixing a few broken and dead links in FTP/SFTP documentation

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Updated FTP/SFTP/FTPS integration documentation with improved link references and navigation. Enhanced cross-references to service and listener documentation throughout the guide. These refinements provide developers with clearer pathways when implementing file transfer integration capabilities.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 18, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 9b3c9dd5-6626-4228-a617-1fefc7c51040

📥 Commits

Reviewing files that changed from the base of the PR and between 40ceaf4 and bade4a7.

📒 Files selected for processing (1)
  • en/docs/develop/integration-artifacts/file/ftp-sftp.md

📝 Walkthrough

Walkthrough

Documentation cross-references in the FTP/SFTP integration guide are updated: the introductory description removes an internal link reference, and a later "general concept" reference is redirected from an external page to a local anchor.

Changes

FTP/SFTP Documentation Links

Layer / File(s) Summary
Documentation link fixes
en/docs/develop/integration-artifacts/file/ftp-sftp.md
Introductory FTP/SFTP/FTPS description removes the linked "file integrations" reference. A "general concept" reference near the "Attaching listeners to services" section is retargeted from an external Services and listeners page to the local #service-and-listener anchor.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • wso2/docs-integrator#467: Related documentation link adjustments in the same repository, targeting cross-reference improvements across different guides.

Suggested reviewers

  • rosensilva
  • anupama-pathirage
  • KavinduZoysa
  • NipunaRanasinghe

Poem

A rabbit hops through docs so bright,
Fixing links from left to right,
Anchors placed with gentle care,
Cross-references now more fair! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete, with only the Purpose section filled in; remaining sections contain only template placeholders with no substantive details about goals, approach, or test coverage. Complete the Goals, Approach, Release note, and other key sections with specific details about how links were fixed, what was changed, and verification performed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely describes the main change: fixing link formatting in FTP/SFTP documentation, which aligns with the summary of updating link references.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@LakshanWeerasinghe LakshanWeerasinghe merged commit 876f85d into wso2:main May 18, 2026
3 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants