Docker: Add static docs to stable releases #1777

Open
opened 2026-02-20 00:59:50 -05:00 by deekerman · 1 comment
Owner

Originally created by @rickysarraf on GitHub (May 18, 2023).

The online PhotoPrism documentation is super awesome. It has some very useful/handy topic like Search Filters. https://docs.photoprism.app/user-guide/search/filters/

This request is to ship/bundle the PhotoPrism documentation along with the built Docker images. This way, users will be self-sufficient and easily be able to find exact and relevant information to a particular build of PhotoPrism.

Originally created by @rickysarraf on GitHub (May 18, 2023). The online PhotoPrism documentation is super awesome. It has some very useful/handy topic like `Search Filters`. https://docs.photoprism.app/user-guide/search/filters/ This request is to ship/bundle the PhotoPrism documentation along with the built Docker images. This way, users will be self-sufficient and easily be able to find exact and relevant information to a particular build of PhotoPrism.
Author
Owner

@lastzero commented on GitHub (May 18, 2023):

While this seems feasible, there are a few drawbacks to consider:

(1) Creating and deploying the documentation (so that it looks good and is easy to use) is additional work that we can't afford right now.
(2) We typically update our documentation several times a week, so bundled documentation would be missing (potentially important) details and explanations that are included in our online docs, for example because a user asked for them and we recently added them.
(3) Bundling the documentation would increase the size of the download or Docker image, and we could only bundle the English documentation, while some users might prefer other language versions.

@lastzero commented on GitHub (May 18, 2023): While this seems feasible, there are a few drawbacks to consider: (1) Creating and deploying the documentation (so that it looks good and is easy to use) is additional work that we can't afford right now. (2) We typically update our documentation several times a week, so bundled documentation would be missing (potentially important) details and explanations that are included in our online docs, for example because a user asked for them and we recently added them. (3) Bundling the documentation would increase the size of the download or Docker image, and we could only bundle the English documentation, while some users might prefer other language versions.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/photoprism#1777
No description provided.