[HWORKS-2856] Add apps docs#604
Merged
Merged
Conversation
Add a new user guide for Hopsworks Apps under Project Guides and expose it in the MkDocs navigation. The new page documents: - the Apps page and lifecycle actions - Streamlit vs custom apps and Git-backed sources - public Streamlit sharing - monitoring and metrics - Python SDK and CLI usage It also explains APP_BASE_URL_PATH with concrete FastAPI, Flask, Gradio, and Express patterns pulled from appshopsworkstests, so app authors can build proxy-aware routes and links correctly. Clarify that Git-backed apps are appropriate for Git-based CI/CD flows and that local working-tree edits do not affect a running deployment until the repository is updated and the app is redeployed.
jimdowling
approved these changes
Jun 10, 2026
- clarify that Apps can host Streamlit, Python web apps, and JavaScript apps such as Express\n- replace the opening usage sentence with a concrete list of common app scenarios\n- keep the app source guidance general with Git-backed CI/CD and proxy-path notes
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
2 participants
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.
Add a new user guide for Hopsworks Apps under Project Guides and expose it in the MkDocs navigation.
The new page documents:
It also explains APP_BASE_URL_PATH with concrete FastAPI, Flask, Gradio, and Express patterns pulled from appshopsworkstests, so app authors can build proxy-aware routes and links correctly.
Clarify that Git-backed apps are appropriate for Git-based CI/CD flows and that local working-tree edits do not affect a running deployment until the repository is updated and the app is redeployed.