Add "For developers" section covering the SEPAL apps catalog#590
Merged
Conversation
Introduces a new top-level section that consolidates developer-facing documentation — the existing CLI pages plus a new "Develop apps" track covering the sepal-apps-catalog workflow: - Docker vs. Jupyter apps — endpoints, isolation, lifecycle - Request a new app — catalog anatomy (id, label, endpoint, repository, branch, path, commit, port, presentation fields, behaviour flags), PR flow to apps.test.json, promotion to apps.prod.json - Request a new kernel — packaging an environment as a hidden jupyter app via sepal_environment.yml, with sepal-sam as the worked example - Create a release — manual SHA bump and the bump-app repository_dispatch flow from a source repo The CLI pages stay at their existing paths (cli/*.html) and are reached through the new umbrella, preserving all public URLs.
Updates app_catalog.rst to reflect dfguerrerom/sepal-apps-catalog#42 (merged), which closes #40 and #41: - Promoting to production now leads with the self-service /promote comment flow (Promote app on /promote comment workflow) and explains the public-org-membership / repo-owner authorization rule. The "restricted to the catalog owner" caveat is gone. - Port row notes that check-docker-rules.js enforces uniqueness across apps.test.json + apps.prod.json and prints "Next free port: N". - Docker path row notes that the id↔path equality check is enforced by check-docker-rules.js (in addition to the schema-enforced prefix).
codespell read the escaped \n + own sequence in the label "Docker app\nown container + port\npinned commit" as the typo "nown". Rewording to "private container" reads better anyway and keeps the hook green.
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
1 participant
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.
Introduces a new top-level For developers section that consolidates developer-facing documentation. It groups the existing CLI pages with a new Develop apps track explaining the
sepal-apps-catalogworkflow.New pages
apps.test.json, and promotion toapps.prod.json.sepal_environment.yml, withsepal-samas the worked example.bump-apprepository_dispatchflow from a source repo.Structure
A new umbrella page
developers/index.rstpulls incli/indexand the newdevelopers/apps/index. The CLI pages stay at their existing paths (cli/*.html) so all public URLs keep working — only navigation changes.The top-level toctree in
index.rstswaps the oldCLIentry for the newDevelopersumbrella.Linked catalog issues
Writing the docs surfaced two gaps in the catalog repo; tracking issues filed:
Verification
nox -s docspasses with zero warnings;check_warnings.pyis green.