Skip to content

docs: add Custom Python component documentation#888

Open
MonikaFeigler wants to merge 2 commits intomainfrom
devin/1773929518-custom-python-docs
Open

docs: add Custom Python component documentation#888
MonikaFeigler wants to merge 2 commits intomainfrom
devin/1773929518-custom-python-docs

Conversation

@MonikaFeigler
Copy link
Copy Markdown
Contributor

Jira issue(s): PROOF-XXX (to be created)

Changes:

  • Add new documentation page for the Custom Python application at /components/applications/custom-python/
  • Add navigation entry under Components → Applications

Content is sourced from the component-custom-python README and covers:

  • Comparison to Python Transformations
  • Configuration parameters (Python version, source, Git settings, user parameters)
  • Code examples using CommonInterface (tables, files, state, error handling, logging)
  • Git repository integration with dependency management (pyproject.toml/uv.lock vs requirements.txt)

Notes for reviewer

  • No screenshots included — other application pages (e.g., Data Gateway) have UI screenshots. Consider whether screenshots of the component's configuration UI should be added before merging.
  • Code-heavy content — the page includes extensive CommonInterface code examples. Please assess whether this level of detail is appropriate for user-facing docs or if some should live on developers.keboola.com instead.
  • Verify the example repo link is publicly accessible.
  • No redirect_from in front matter — intentional since this is a new page with no legacy URL.

Release Notes

Justification, description

New user documentation for the Custom Python component (application), enabling users to find guidance on configuring and using the component directly from help.keboola.com.

Plans for Customer Communication

N/A

Impact Analysis

Documentation-only change. No functional impact.

Deployment Plan

Standard merge to main — auto-deployed via Jekyll build.

Rollback Plan

Revert the merge commit.

Post-Release Support Plan

N/A

Link to Devin session: https://app.devin.ai/sessions/e9ef647896ee46529d9e0eda29d2b962
Requested by: @MonikaFeigler

Co-Authored-By: Monika Feigler <monika@feigler.cz>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

Summary

  • Add new documentation page for the Custom Python application at /components/applications/custom-python/
  • Add navigation entry under Components → Applications
  • Rewrote content to be user-facing rather than developer-facing: replaced 9 code examples with a single minimal snippet and a link to developer docs,
    removed raw JSON configuration examples, removed JSON parameter key names from UI field descriptions
  • Added 5 UI screenshots covering the component overview, Python version selection, inline code editor, User Parameters, and Git repository configuration

@MonikaFeigler MonikaFeigler marked this pull request as ready for review March 19, 2026 14:49
@MonikaFeigler MonikaFeigler requested a review from kudj March 19, 2026 14:49
@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

@kudj can you please review this docs for custom python please?

Copy link
Copy Markdown
Contributor

@jordanrburger jordanrburger left a comment

Choose a reason for hiding this comment

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

It would be great to have a note on this page about the possibility of configuring the custom python component easily with Kai.

Copy link
Copy Markdown
Contributor Author

@jordan.burger great comment. Feel free to propose changes and send it to me for review. Thank you. 🙂

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