Refine docker-vs-jupyter framing, de-emphasize legacy endpoints, expand kernels for training content - #591
Merged
Merged
Conversation
…nd kernels for training content Iteration on the developers section in response to review feedback: app_types.rst - New legacy note: shiny is no longer recommended for new apps; rstudio is reserved for the built-in tool. - "At a glance" table reworked around the real distinction developers care about: docker runs on the shared SEPAL server (one instance for all users), jupyter runs inside each user's own sandbox (compute scales with what the user provisions). - Code location row clarifies that both endpoints clone from repository; only the destination differs (container vs /home/sepal-user/shared/apps/<app>/). - Isolation row drops "optional packaged kernel" — for jupyter apps the micromamba kernel built from sepal_environment.yml is the rule, not the exception. - Lifecycle row renamed to "Update trigger" and reframed: both update independently of the sandbox; what differs is whether the trigger is a catalog commit bump or a branch-tip push. - Expanded "Docker apps" and "Jupyter apps" sections to spell out the resource model (shared single backend vs per-user instance compute). - New "When to use which" rule-of-thumb table at the bottom. app_catalog.rst - Endpoint row notes only jupyter/docker for new apps. - path row drops the shiny variant. - Lead paragraph drops "jupyter and shiny" in favor of "jupyter". releases.rst - Drops shiny from the per-endpoint breakdown and the heading. - Adds .. _developers_apps_releases_branch: label so other pages can link the release-branch convention. kernels.rst - "Same PR flow / release lifecycle" sentence now hyperlinks to app_catalog and releases (jupyter sub-section). - New "Ship notebooks and data alongside the kernel" section: the cloned repo lands under /home/sepal-user/shared/apps/<app>/ on every user's sandbox, so the same mechanism is also how to ship training notebooks and small data alongside the env. apps/index.rst - Drops "shiny" from the catalog-role note.
- "Who pays for compute" -> "Where compute happens" (SEPAL funds both runtimes — the distinction is location, not who pays). - Docker update trigger is the app-launcher checking out the new commit at launch time, not the app-manager.
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
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.
Follow-up review on the developers section merged in #590.
What this changes
app_types.rst— bigger restructureshinyis no longer recommended for new apps;rstudiois reserved for the built-in tool. A note at the top says so plainly.repository; only the destination differs (container vs/home/sepal-user/shared/apps/<app>/).sepal_environment.ymlis the rule.app_catalog.rstjupyter/dockerare recommended for new apps.pathdescription.releases.rst.. _developers_apps_releases_branch:label so other pages can link the release-branch convention.kernels.rstapp_catalogand the jupyter sub-section ofreleases./home/sepal-user/shared/apps/<app>/on every user's sandbox, so the same mechanism is also the right way to ship training notebooks and supporting data to a cohort. Covers practical conventions (top-level notebooks, keep large data external, tag areleasebranch per cohort).apps/index.rstVerification
nox -s docs— green, zero warnings.nox -s lint— black, ruff, prettier, doc8, codespell all pass.