Grammar and syntax edits for the new docs (#936)

* Update introduction.mdx

* Update logo-mearning.md

* Update support-the-project.md

Fixing more grammar/syntax :)

* Update one-step-installation.md

* Update recommended-installation.md

* Update requirements.md

* Update automatic-backup.md

* Update bulk-upload.md

* Update post-installation.md

* Update update.md

* Update contribution-guidelines.md
This commit is contained in:
Coyote6705
2022-11-06 22:27:14 -05:00
committed by GitHub
parent 2ff1a81f19
commit 948ff5530c
11 changed files with 37 additions and 37 deletions

View File

@@ -18,13 +18,13 @@ On Android, there are two options for automatic backup
## Foreground backup
If foreground backup is enabled. Whenever the app is opened or resumed, it will check if any photos or videos in the selected album(s) have yet to be uploaded to the cloud (the remainder count). If there are any, it will upload them to the cloud.
If foreground backup is enabled: whenever the app is opened or resumed, it will check if any photos or videos in the selected album(s) have yet to be uploaded to the cloud (the remainder count). If there are any, they will be uploaded.
## Background backup
Background backup is only available on Android thanks to the contribution effort of [@zoodyy](https://github.com/zoodyy).
If background backup is enabled. The app will periodically check if any photos or videos in the selected album(s) still need to be uploaded to the cloud. If there are any, it will upload them to the cloud in the background.
If background backup is enabled. The app will periodically check if there are any new photos or videos in the selected album(s) to be uploaded to the cloud. If there are, it will upload them to the cloud in the background.
A native Android notification shows up when the background upload is in progress. You can further customize the notification by going to the app's settings.
@@ -32,4 +32,4 @@ A native Android notification shows up when the background upload is in progress
* The app must be in the background for the backup worker to start running.
* It is a well-known problem that some Android models are very strict with battery optimization settings, which can cause a problem with the background worker. Please visit [Don't kill my app](https://dontkillmyapp.com/) for a guide on disabling this setting on your phone.
* If you reopen the app and the first page you see is the backup page, the counts will reflect the background uploaded result. You have to navigate out of the page and come back to see the updated counts.
:::
:::

View File

@@ -4,7 +4,7 @@ sidebar_position: 3
# Bulk Upload (Using the CLI)
You can use the CLI to upload the existing gallery to the Immich's server
You can use the CLI to upload an existing gallery to the Immich server
[Immich CLI Repository](https://github.com/immich-app/CLI)
@@ -19,7 +19,7 @@ npm i -g immich
```
## Quick Start
Specify user's credential, Immich's server address and port and the directory you would like to upload videos/photos from.
Specify user's credentials, Immich's server address and port, and the directory you would like to upload videos/photos from.
```bash
immich upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d your/target/directory
@@ -42,7 +42,7 @@ immich upload --email testuser@email.com --password password --server http://192
### Run via Docker
Be aware that as this runs inside a container, it mounts your current directory as a volume and for the -d flag you need to use the path inside the container.
Be aware that as this runs inside a container it mounts your current directory as a volume, and for the -d flag you need to use the path inside the container.
```bash
docker run -it --rm -v $(pwd):/import ghcr.io/immich-app/immich-cli:latest upload --email testuser@email.com --password password --server http://192.168.1.216:2283/api -d /import

View File

@@ -14,7 +14,7 @@ The mobile app can be downloaded from
- [Apple App Store](https://apps.apple.com/us/app/immich/id1613945652)
- [F-Droid](https://f-droid.org/packages/app.alextran.immich)
## Step 2 - Registering the admin user
## Step 2 - Register the admin user
The first user to register will be the admin user. The admin user will be able to add other users to the application.
@@ -24,7 +24,7 @@ To register for the admin user, access the web application at `http://<machine-i
Follow the prompts to register as the admin user and log in to the application.
## Step 3 - Creating a new user (optional)
## Step 3 - Create a new user (optional)
If you have a family member who wants to use the application, you can create a new account. The default password is `password`, and the user can change their password after logging in to the application for the first time.
@@ -42,7 +42,7 @@ Navigate to the backup screen by clicking on the cloud icon in the top right cor
<img src={require('./img/backup-header.png').default} width="50%" title="Backup button" />
You can select the album you want to back up from the backup screen to the Immich server.
You can select which album(s) you want to back up to the Immich server from the backup screen.
<img src={require('./img/album-selection.png').default} width="50%" title="Backup button" />
@@ -54,4 +54,4 @@ You can also enable auto foreground or background backup (only on Android). For
:::tip Application Mechanism
#### [Foreground and background backup](/docs/usage/automatic-backup)
#### [Bulk upload (using the CLI)](/docs/usage/bulk-upload)
:::
:::

View File

@@ -4,8 +4,8 @@ sidebar_position: 4
# Update the application
If you are using Docker Compose, to update the application use the following commands in the directory where the `docker-compose.yml` file is located:
If you are using Docker Compose, update the application use the following commands in the directory where the `docker-compose.yml` file is located:
```bash title="Update Immich"
docker-compose pull && docker-compose up -d # Or `docker compose`
```
```