Skip to content

Commit

Permalink
docs: Split features into new administration category (immich-app#1440)
Browse files Browse the repository at this point in the history
* docs: Split features into new administration category

* docs: Add redirects for moved pages
  • Loading branch information
bo0tzz authored Jan 27, 2023
1 parent de0e218 commit 1152cd4
Show file tree
Hide file tree
Showing 26 changed files with 28 additions and 17 deletions.
8 changes: 4 additions & 4 deletions docs/docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---

# FAQ
Expand All @@ -20,9 +20,9 @@ Immich doesn't have the mechanism to sync an existing directory with the server.

The initial approach of Immich is to become a backup tool, primarily for mobile device usage. Thus, all the assets must be uploaded from the mobile client. The app was architectured to perform that job well.

### What happens to existing files after I choose a new [Storage Template](/docs/features/storage-template.mdx)?
### What happens to existing files after I choose a new [Storage Template](/docs/administration/storage-template.mdx)?

Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/features/jobs.md) page.
Template changes will only apply to new assets. To retroactively apply the template to previously uploaded assets, run the Storage Migration Job, available on the [Jobs](/docs/administration/jobs.md) page.

### Why is object detection not very good?

Expand All @@ -42,7 +42,7 @@ The non-root user/group needs read/write access to the volume mounts, including

### How can I reset the admin password?

The admin password can be reset by running the [reset-admin-password](/docs/features/server-commands.md) command on the immich-server.
The admin password can be reset by running the [reset-admin-password](/docs/administration/server-commands.md) command on the immich-server.

### How can I **purge** data from Immich?

Expand Down
5 changes: 5 additions & 0 deletions docs/docs/administration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "Administration",
"position": 4
}

File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Several Immich functionalities are implemented as jobs, which run in the backgro

## Storage Migration

This job can be run after changing the [Storage Template](/docs/features/storage-template.mdx), in order to apply the change to the existing library.
This job can be run after changing the [Storage Template](/docs/administration/storage-template.mdx), in order to apply the change to the existing library.

![Storage Migration](./img/admin-jobs-template.png)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ To toggle the password login setting via the web, navigate to the "Administratio

### Server Command

There are two [Server Commands](/docs/features/server-commands.md) for password login:
There are two [Server Commands](/docs/administration/server-commands.md) for password login:

1. `enable-password-login`
2. `disable-password-login`

See [Server Commands](/docs/features/server-commands.md) for more details about how to run them.
See [Server Commands](/docs/administration/server-commands.md) for more details about how to run them.

## Password Reset

### Admin

To reset the administrator password, use the `reset-admin-password` [Server Command](/docs/features/server-commands.md).
To reset the administrator password, use the `reset-admin-password` [Server Command](/docs/administration/server-commands.md).

### User

Immich does not currently support self-service password reset. However, the administration can reset passwords for other users. See [User Management: Password Reset](/docs/features/user-management.mdx#password-reset) for more information about how to do this.
Immich does not currently support self-service password reset. However, the administration can reset passwords for other users. See [User Management: Password Reset](/docs/administration/user-management.mdx#password-reset) for more information about how to do this.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/developer/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Developer",
"position": 4
"position": 5
}
4 changes: 2 additions & 2 deletions docs/docs/features/user-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Users can change their own passwords.
![Change Password](./img/user-change-password.png)

:::tip Reset Password
The admin can reset a password through the [User Management](/docs/features/user-management.mdx) screen.
The admin can reset a password through the [User Management](/docs/administration/user-management.mdx) screen.
:::

:::tip Reset Admin Password
The admin password can be reset using a [Server Command](/docs/features/server-commands.md)
The admin password can be reset using a [Server Command](/docs/administration/server-commands.md)
:::
2 changes: 1 addition & 1 deletion docs/docs/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Guides",
"position": 5
"position": 6
}
10 changes: 8 additions & 2 deletions docs/vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@
{ "source": "/docs/overview/technology-stack", "destination": "/docs/developer/architecture" },
{ "source": "/docs/usage/automatic-backup", "destination": "/docs/features/automatic-backup" },
{ "source": "/docs/usage/bulk-upload", "destination": "/docs/features/bulk-upload" },
{ "source": "/docs/usage/oauth", "destination": "/docs/features/oauth" },
{ "source": "/docs/usage/oauth", "destination": "/docs/administration/oauth" },
{ "source": "/docs/usage/post-installation", "destination": "/docs/install/post-install" },
{ "source": "/docs/usage/update", "destination": "/docs/install/docker-compose#step-4---upgrading" },
{ "source": "/docs/usage/server-commands", "destination": "/docs/features/server-commands" }
{ "source": "/docs/usage/server-commands", "destination": "/docs/administration/server-commands" },
{ "source": "/docs/features/jobs", "destination": "/docs/administration/jobs" },
{ "source": "/docs/features/oauth", "destination": "/docs/administration/oauth" },
{ "source": "/docs/features/password-login", "destination": "/docs/administration/password-login" },
{ "source": "/docs/features/server-commands", "destination": "/docs/administration/server-commands" },
{ "source": "/docs/features/storage-template", "destination": "/docs/administration/storage-template" },
{ "source": "/docs/features/user-management", "destination": "/docs/administration/user-management" }
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<p class="text-md text-center">
To re-enable, use a
<a
href="https://immich.app/docs/features/server-commands"
href="https://immich.app/docs/administration/server-commands"
rel="noreferrer"
target="_blank"
class="underline"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<form autocomplete="off" on:submit|preventDefault class="flex flex-col mx-4 gap-4 py-4">
<p class="text-sm dark:text-immich-dark-fg">
For more details about this feature, refer to the <a
href="http://immich.app/docs/features/oauth#mobile-redirect-uri"
href="http://immich.app/docs/administration/oauth#mobile-redirect-uri"
class="underline"
target="_blank"
rel="noreferrer">docs</a
Expand Down

0 comments on commit 1152cd4

Please sign in to comment.