Skip to content

docs: point model developers to the Chap guides for the MLproject flow (CLIM-1477) - #158

Open
ivargr wants to merge 1 commit into
mainfrom
docs/point-model-developers-to-chap-guides
Open

ivargr wants to merge 1 commit into
mainfrom
docs/point-model-developers-to-chap-guides

Conversation

@ivargr

@ivargr ivargr commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Points model developers who land on chapkit first to the Chap guides for the MLproject flow. In an external modeler test, a statistician with an existing R model searched for chapkit, was told to install it, migrate the project and run a chap-core stack, and never found the Chap docs, which describe a much shorter path: train and predict scripts, an MLproject file and chap eval --run-config.as-chapkit.

  • docs/index.md: a tip at the top saying that running a model in Chap needs no chapkit service or chapkit install, with links to the two Chap guides.
  • docs/guides/mlproject-runner.md: says that chap eval --run-config.as-chapkit starts chapkit mlproject run itself, with the same links.
  • README.md: the same pointer, for readers who find the repository on GitHub.

The "Bring your existing model to Chap" page is added in dhis2-chap/chap-core#830, so that link works once it is merged and the Chap site is redeployed.

Test plan

  • mkdocs build --strict passes.

Jira: CLIM-1477

@codecov

codecov Bot commented Nov 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@ivargr
ivargr marked this pull request as ready for review November 4, 2026 12:05

This branch has not been deployed

No deployments
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