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

docs: background backup FAQ #9142

Merged
merged 5 commits into from
Apr 28, 2024
Merged

docs: background backup FAQ #9142

merged 5 commits into from
Apr 28, 2024

Conversation

alextran1502
Copy link
Contributor

Because I answered these question too many times

Copy link

cloudflare-pages bot commented Apr 28, 2024

Deploying immich with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7177b62
Status: ✅  Deploy successful!
Preview URL: https://ea009d14.immich.pages.dev
Branch Preview URL: https://docs-background-task-faq.immich.pages.dev

View logs

@alextran1502 alextran1502 added the documentation Improvements or additions to documentation label Apr 28, 2024
Copy link
Contributor

@mmomjian mmomjian left a comment

Choose a reason for hiding this comment

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

Ty! Most of my suggestions are related to phone -> device (the same concepts should apply to iPad and Android tablets).

docs/docs/FAQ.mdx Outdated Show resolved Hide resolved
docs/docs/FAQ.mdx Outdated Show resolved Hide resolved
iPhone determines if a particular app can invoke background tasks by multiple factors, most of which we don't know and don't have control over. To increase the likelihood that background backup can run, follow the steps below:

- Make sure you enable Background App Refresh in the phone's settings. `Settings > General > Background App Refresh`.
- Disable Background App Refresh for apps that don't need background tasks to run. This will reduce the competition for background task invocation for Immich.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Disable Background App Refresh for apps that don't need background tasks to run. This will reduce the competition for background task invocation for Immich.
- Disable Background App Refresh for apps that don't need background tasks to run.
- This will reduce the competition for background task invocation for Immich.

Copy link
Member

Choose a reason for hiding this comment

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

I personally like the current formatting more

Copy link
Contributor

Choose a reason for hiding this comment

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

Makes sense. I was trying to divide "action steps" from "background details", but it's not strictly necessary for a short blurb like this.

docs/docs/FAQ.mdx Outdated Show resolved Hide resolved
docs/docs/FAQ.mdx Outdated Show resolved Hide resolved
alextran1502 and others added 4 commits April 28, 2024 14:18
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
Co-authored-by: Matthew Momjian <50788000+mmomjian@users.noreply.github.com>
@alextran1502 alextran1502 enabled auto-merge (squash) April 28, 2024 19:19
@alextran1502 alextran1502 merged commit a2cf8c7 into main Apr 28, 2024
22 of 23 checks passed
@alextran1502 alextran1502 deleted the docs/background-task-faq branch April 28, 2024 19:23

Foreground backup is controlled by the user's action, while background backup is controlled by your device's operating system. When the app is put in the background, the invocation of background tasks is delegated to the device's operating system scheduler. It decides when the background task can run and how long it can run.

The behaviors differ based on your device manufacturer and operating system, but most are related to battery-saving policies.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The behaviors differ based on your device manufacturer and operating system, but most are related to battery-saving policies.
The behavior differs based on your device manufacturer and operating system, but most are related to battery-saving policies.

iPhone determines if a particular app can invoke background tasks by multiple factors, most of which we don't know and don't have control over. To increase the likelihood that background backup can run, follow the steps below:

- Make sure you enable Background App Refresh in the phone's settings. `Settings > General > Background App Refresh`.
- Disable Background App Refresh for apps that don't need background tasks to run. This will reduce the competition for background task invocation for Immich.
Copy link
Member

Choose a reason for hiding this comment

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

I personally like the current formatting more

@danieldietzler
Copy link
Member

Lol sad

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants