Skip to content
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

usage-basic-overview.md #29

Merged
merged 8 commits into from
Jul 18, 2024
Merged

usage-basic-overview.md #29

merged 8 commits into from
Jul 18, 2024

Conversation

hgpuke
Copy link
Contributor

@hgpuke hgpuke commented Jun 26, 2024

Added content to the usage-basic-overview page.
Added the same screenshot at the top as in the installation page.

Copy link
Contributor

@kkovaletp kkovaletp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution! This is a nice and descriptive overview.

To make it even better, I've added a list of suggestions in the comments to the particular sections, but in general, I'd recommend you running the text through a grammar-checking tool (like Grammarly editor) and fix typos and styling)

src/en/docs/timeline.png Outdated Show resolved Hide resolved
There is an "X" in the top left of the photo. Clicking this takes you back to the timeline view.
- **Click on the heart.** Placing the mouse cursor over the photo, you will see two symbols: In the bottom-left of the photo is a outline of a ♥ and in the upper-right there is an ⓘ. Clicking the heart-outline changes it to a solid heart to indicate that the photo is one of your favourites.
On the top of the screen there is a `checkbox` with the text "Show only favourites" next to it and checking it will only show the photos that you have marked with the heart.
- **Click on the ⓘ** to open up a panel on the right side of the screen where you can see some metadata for that photo, such as when the photo was taken, with which camera, its exposure settings etc. It also shows the _path to the album/folder_ where the photo is stored. Clicking on the album path allows you to see all the photos from that album. Furthermore you can also see which faces that have been identified and the location where it was taken (if known). At the bottom of the panel, you have the option to download this photo to your computer or create a link that can be shared with others. More on that later.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which faces that have been identified

... (if this feature is enabled)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you decide to not implement this change or just missed to add it?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You didn't answer me in this thread, so I'm just checking) This is not critical, just want to make sure you didn't miss it)

src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
@kkovaletp kkovaletp added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 26, 2024
@hgpuke
Copy link
Contributor Author

hgpuke commented Jun 27, 2024 via email

@kkovaletp
Copy link
Contributor

There is no need to create a new PR. You can just commit your new changes to the same branch, used as a source for the current PR, and they will appear here automatically.

The corresponding environment variables control features, which can be disabled in the product:

  • PHOTOVIEW_DISABLE_FACE_RECOGNITION: if set to true, disables Face recognition feature and People section in the UI
  • PHOTOVIEW_DISABLE_VIDEO_ENCODING: if set to true, instructs Photoview to track videos as unsupported files and don't catalog them
  • PHOTOVIEW_DISABLE_RAW_PROCESSING: if set to true, does the same as the previous switch, but for RAW image files
  • MAPBOX_TOKEN: if empty or missing, the Places section is disabled in the UI

Users might decide to disable some of the features because:

  • they don't use/need them
  • they are not currently supported by the server, hosting Photoview (in the case of the direct installation on the host)
  • they require too many server resources, not available on the server (typically when hosting Photoview on some Raspberry-Pi, or slow NAS servers; or any similar hardware with not enough resources)
  • they worry a lot about privacy and don't trust the 3rd-party MapBox code, integrated into Photoview, so they prefer to completely disable the feature than deep-dive into the integration and trust that the future changes on the MapBox side won't introduce some data leaks

@hgpuke
Copy link
Contributor Author

hgpuke commented Jun 27, 2024 via email

@hgpuke
Copy link
Contributor Author

hgpuke commented Jun 28, 2024 via email

@kkovaletp
Copy link
Contributor

@hgpuke, after making some commits and ready to go forward, you need to push them from your local system to the remote server: git push

src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
There is an "X" in the top left of the photo. Clicking this takes you back to the timeline view.
- **Click on the heart.** Placing the mouse cursor over the photo, you will see two symbols: In the bottom-left of the photo is a outline of a ♥ and in the upper-right there is an ⓘ. Clicking the heart-outline changes it to a solid heart to indicate that the photo is one of your favourites.
On the top of the screen there is a `checkbox` with the text "Show only favourites" next to it and checking it will only show the photos that you have marked with the heart.
- **Click on the ⓘ** to open up a panel on the right side of the screen where you can see some metadata for that photo, such as when the photo was taken, with which camera, its exposure settings etc. It also shows the _path to the album/folder_ where the photo is stored. Clicking on the album path allows you to see all the photos from that album. Furthermore you can also see which faces that have been identified and the location where it was taken (if known). At the bottom of the panel, you have the option to download this photo to your computer or create a link that can be shared with others. More on that later.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you decide to not implement this change or just missed to add it?

Copy link
Contributor

@kkovaletp kkovaletp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments still to address

src/en/docs/usage-basic-overview.md Outdated Show resolved Hide resolved
@kkovaletp
Copy link
Contributor

I've added 1 comment to the existing thread. Other than that it looks good to me.
I'll not merge it until you explicitly confirm that the future pages will be delivered in other branches (as we discussed in the chat)

	modified:   src/assets/images/screenshot-map-twoset.png
	new file:   src/assets/images/screenshot-maps2.png
	modified:   src/en/docs/usage-basic-overview.md
	modified:   src/en/docs/usage-people.md
	modified:   src/en/docs/usage-places.md
	modified:   src/en/docs/usage-sharing.md
Copy link
Contributor

@kkovaletp kkovaletp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hgpuke, thanks for your valuable contribution to the documentation of Photoview!
Now it looks good to me to merge it, so I'm approving the PR.

I have a small (and optional) comment regarding the Sharing doc page: I think that it is pretty obvious, but might still make sense to mention that Photoview is a self-hosted service, relying completely on a user in making it accessible from Internet or within the local network. This means that in the case of incorrect configuration the Sharing functionality will generate inaccessible links. This is user's responsibility to configure it correctly. Photoview cannot handle this.

If you think that it makes sense to publish, it looks like the best place for that would be the 2nd paragraph on the Sharing page.

@hgpuke
Copy link
Contributor Author

hgpuke commented Jul 9, 2024 via email

@kkovaletp
Copy link
Contributor

No rush, we could wait till next week - that is not a problem. Take your time)

@kkovaletp kkovaletp merged commit 4babb65 into photoview:master Jul 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants