Skip to content

Config: Improve inline docs in docker-compose.yml examples #2536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

sssheridan
Copy link

@sssheridan sssheridan commented Jul 20, 2022

This is my first-ever pull request. If I've done this right, I'll contribute more substantially later.

In this commit, I edited a few comments for clarity. Should such edits be made individually to each architecture's docker-compose.yml, or is there a root file which propagates to the different architectures?

The primary reason for this edit in particular was the "# Raspberry V4L2" line. I initially (naively) thought this entry referred to hardware acceleration on the Raspberry Pi; I added "(camera driver)" to make it clear.

Acceptance Criteria:

  • Features and improvements are fully implemented so that they can be released at any time without additional work
  • Automated unit and/or acceptance tests have been added to ensure the changes work as expected and to reduce repetitive manual work
  • User interface changes are fully responsive and have been tested on all major browsers and various devices
  • Database-related changes are compatible with SQLite and MariaDB
  • Translations have been / will be updated (specify if needed)
  • Documentation has been / will be updated (specify if needed)
  • Contributor License Agreement (CLA) has been signed

Edited a few comments for clarity. 

The primary reason for this edit is the "# Raspberry V4L2 (camera driver)" change. I initially (naively) thought this entry was required in order to use hardware acceleration on the Raspberry Pi.
@CLAassistant
Copy link

CLAassistant commented Jul 20, 2022

CLA assistant check
All committers have signed the CLA.

@lastzero
Copy link
Member

lastzero added a commit that referenced this pull request Jul 22, 2022
Signed-off-by: Michael Mayer <michael@photoprism.app>
@lastzero
Copy link
Member

Will these changes work for you?

@lastzero lastzero changed the title Update comments in ARM64 docker-compose.yml Config: Improve parameter comments in docker-compose.yml examples Jul 22, 2022
@lastzero lastzero added docs 📚 Improvements or additions to documentation docker Docker Images, Build Scripts, Config & Deployment Examples labels Jul 22, 2022
@lastzero lastzero changed the title Config: Improve parameter comments in docker-compose.yml examples Config: Improve parameter docs in docker-compose.yml examples Jul 22, 2022
@lastzero lastzero changed the title Config: Improve parameter docs in docker-compose.yml examples Config: Improve inline docs in docker-compose.yml examples Jul 22, 2022
lastzero added a commit that referenced this pull request Jul 29, 2022
Signed-off-by: Michael Mayer <michael@photoprism.app>
lastzero added a commit that referenced this pull request Jul 29, 2022
Signed-off-by: Michael Mayer <michael@photoprism.app>
lastzero added a commit that referenced this pull request Jul 29, 2022
Signed-off-by: Michael Mayer <michael@photoprism.app>
@jackbrown1993
Copy link

These changes look good to me.

@lastzero lastzero closed this Sep 28, 2022
@lastzero lastzero added the released Available in the stable release label Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Docker Images, Build Scripts, Config & Deployment Examples docs 📚 Improvements or additions to documentation released Available in the stable release
Projects
Status: Release 🌈
Development

Successfully merging this pull request may close these issues.

4 participants