Skip to content

docs: add Northflank deployment guide#10439

Closed
AdeboyeDN wants to merge 2 commits into
langflow-ai:mainfrom
AdeboyeDN:docs/add-northflank-deployment
Closed

docs: add Northflank deployment guide#10439
AdeboyeDN wants to merge 2 commits into
langflow-ai:mainfrom
AdeboyeDN:docs/add-northflank-deployment

Conversation

@AdeboyeDN
Copy link
Copy Markdown

@AdeboyeDN AdeboyeDN commented Oct 29, 2025

This pull request adds a new guide explaining how to deploy Langflow on Northflank using a one-click stack template.

Summary by CodeRabbit

  • Documentation
    • Added Northflank deployment guide featuring step-by-step instructions, one-click template deployment, optional configuration options, and dashboard access guidance for users.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 29, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new Northflank deployment documentation page is added to the Langflow docs with step-by-step deployment instructions. The sidebar configuration is updated to include this documentation entry in the Cloud platforms deployment section.

Changes

Cohort / File(s) Change Summary
Documentation and Sidebar Configuration
docs/docs/Deployment/deployment-northflank.mdx, docs/sidebars.js
New Northflank deployment guide added with frontmatter metadata, deployment workflow steps, and configuration instructions. Sidebar navigation updated to include Northflank entry between Hugging Face Spaces and Railway.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation content is straightforward instructional material without complex logic
  • Sidebar entry addition is a simple configuration change following existing patterns

Possibly related PRs

Suggested labels

documentation, size:L

Suggested reviewers

  • mendonk
  • aimurphy
  • ogabrielluiz

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 2 inconclusive)
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.
Test Quality And Coverage ❓ Inconclusive This PR adds a new Northflank deployment guide documentation file and updates the documentation sidebar configuration. The changes consist entirely of documentation (a new .mdx file and a sidebar configuration update) with no code implementations, API endpoints, or async functions. According to Langflow's contribution guidelines, documentation contributions focus on content creation in .mdx format and sidebar navigation updates, with no specific testing requirements mandated for documentation-only changes. The custom check instructions are designed to evaluate test quality for new functional implementations (backend code, frontend code, API endpoints) using testing frameworks like pytest and Playwright, but this PR contains no such implementations and therefore no new executable code requiring tests. The custom check for "Test Quality and Coverage" is not applicable to this PR since it adds only documentation content without any new code implementations, API endpoints, or functional changes that would require testing. The check instructions presuppose new code being added that requires test coverage (backend, frontend, async functions, API endpoints), but this PR is purely documentation-focused. Clarification is needed on whether documentation-only PRs should be evaluated by this check, or if a separate documentation quality check should be applied instead.
Test File Naming And Structure ❓ Inconclusive This pull request is a documentation-only change that adds a new deployment guide for Northflank. The modifications include adding a new Markdown file (docs/docs/Deployment/deployment-northflank.mdx) and updating a configuration file (docs/sidebars.js) to add a navigation entry. No backend code (Python), frontend code (TypeScript/React), or integration code has been added or modified, which means there are no code changes that would require associated test files following pytest, Playwright, or other testing patterns. The custom check for "Test File Naming and Structure" is designed to verify test files for code changes (backend, frontend, and integration tests). Since this PR contains only documentation and configuration changes with no testable code modifications, the check's verification criteria do not apply. Consider clarifying whether this check should be skipped automatically for documentation-only PRs, or if it should always be run as a formality.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "docs: add Northflank deployment guide" directly and accurately describes the primary changes in this PR. The changeset adds a new documentation file providing a step-by-step guide for deploying Langflow on Northflank, along with a corresponding sidebar navigation entry. The title is concise, specific, and uses the appropriate "docs:" prefix for documentation-focused changes, making it clear to teammates reviewing history what the main contribution is.
Test Coverage For New Implementations ✅ Passed This pull request is a documentation-only change that adds a deployment guide file and updates the sidebar navigation. The check instructions are designed for code changes (new components, features, or bug fixes) that require unit or integration tests. The project's test infrastructure (pytest with testpaths limited to src/backend/tests and src/lfx/tests) does not cover documentation files. Additionally, all existing deployment guides in the same directory follow the same pattern with no corresponding test files, establishing that documentation additions do not require code tests in this project.
Excessive Mock Usage Warning ✅ Passed The PR status confirms that only two files are modified: a new documentation file docs/docs/Deployment/deployment-northflank.mdx (Added) and the sidebar configuration docs/sidebars.js (Modified). The custom check requires reviewing test files for excessive mock usage, but this PR contains no test files whatsoever—only documentation and configuration changes. Therefore, the check does not apply to this PR.

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.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 29, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/docs/Deployment/deployment-northflank.mdx (1)

23-25: Consider formatting "Running" as a bold UI element.

The service status "Running" appears in quotes but should be formatted as a bold UI element for consistency with documentation guidelines.

Apply this diff:

-   Northflank will automatically build, deploy, and start Langflow. Once the service status shows as "Running," your instance is live.
+   Northflank will automatically build, deploy, and start Langflow. Once the service status shows as **Running**, your instance is live.
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c8935c and 77c51e1.

📒 Files selected for processing (2)
  • docs/docs/Deployment/deployment-northflank.mdx (1 hunks)
  • docs/sidebars.js (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

docs/**/*.{md,mdx}: All Markdown/MDX pages must start with front matter including at least title and description; include sidebar_position for docs pages when applicable
Code blocks must specify a language and may include a title (```lang title="…")
Use sentence case for headings and keep paragraphs short and scannable
Write in second person, present tense, with a professional but approachable tone
Use inline code with backticks for code terms; use bold for UI elements and italics for emphasis; keep lists in parallel structure
Ensure internal links are functional and navigation works (update cross-references as needed)
Verify all code examples in docs and blog actually run as shown
Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Reference images with absolute paths under /img/... and provide descriptive alt text

Files:

  • docs/docs/Deployment/deployment-northflank.mdx
docs/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages

Files:

  • docs/docs/Deployment/deployment-northflank.mdx
docs/sidebars.js

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

Keep sidebars.js updated to include new/changed docs sections and items using Docusaurus category structure

Files:

  • docs/sidebars.js
🪛 LanguageTool
docs/docs/Deployment/deployment-northflank.mdx

[grammar] ~21-~21: Ensure spelling is correct
Context: ...nvironment variables or link additional addons directly from your Northflank dashboard...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

⏰ 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: Test Docs Build / Test Docs Build
🔇 Additional comments (2)
docs/docs/Deployment/deployment-northflank.mdx (1)

1-5: Front matter looks good!

The front matter includes all required fields (title, description, slug) and follows the documentation standards.

docs/sidebars.js (1)

241-245: Sidebar entry correctly structured and positioned!

The new Northflank documentation entry follows the standard Docusaurus structure, uses the correct document ID matching the file path, and is positioned alphabetically within the Cloud platforms section.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 30, 2025
@mendonk
Copy link
Copy Markdown
Collaborator

mendonk commented Nov 19, 2025

Thanks for your contribution @AdeboyeDN but we don't need this right now.

@mendonk mendonk closed this Nov 19, 2025
@DeciderWill
Copy link
Copy Markdown

hey @mendonk, the guide has already been written by Daniel above. The Northflank template works on AWS, GCP, Azure, CoreWeave and any K8s cluster. That would allow Langflow to be deployed to many more deployment targets in a single click than the guides currently merged for Render, Railway, Huggingface Spaces and GCP Cloudshell. Why does it not make sense to merge this if the work has already been done? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants