Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Sep 17, 2023
1 parent 35bb3d1 commit 7664dcb
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ on the standard Config class if nothing is found in the database.
Shield has a model to handle user persistence. Shield calls this the "User Provider" class.
A default model is provided for you by the `CodeIgniter\Shield\Models\UserModel` class.

You can use your own model to customize user attributes. See [Customizing Shield](./customization.md#custom-user-provider) for details.
You can use your own model to customize user attributes. See [Customizing User Provider](./customization/user_provider.md) for details.

## User Identities

Expand Down
2 changes: 1 addition & 1 deletion docs/customization/login_identifier.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This only works with the Session authenticator.
];
```
> **Warning**
> It is very important for security that if you add a new column for identifier you must write a new **Validation Rules** and then set it using the [custom-validation-rules](https://github.com/codeigniter4/shield/blob/develop/docs/customization.md#custom-validation-rules) description.
> It is very important for security that if you add a new column for identifier, you must write a new **Validation Rules** and then set it using the [Customizing Validation Rules](./validation_rules.md) description.

3. Edit the login form to change the name of the default `email` input to the new field name.

Expand Down
2 changes: 1 addition & 1 deletion docs/customization/user_provider.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Customizing User Provider

If you want to customize user attributes, you need to create your own
[User Provider](./concepts.md#user-providers) class.
[User Provider](../concepts.md#user-providers) class.
The only requirement is that your new class MUST extend the provided `CodeIgniter\Shield\Models\UserModel`.

Shield has a CLI command to quickly create a custom `UserModel` class by running the following
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/strengthen_password.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ By default, Shield has the validation rules for maximum password length.
- 72 bytes for PASSWORD_BCRYPT
- 255 characters for others

You can customize the validation rule. See [Customizing Shield](../customization.md).
You can customize the validation rule. See [Customizing Validation Rules](../customization/validation_rules.md).

## $supportOldDangerousPassword

Expand Down
4 changes: 2 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Require it with an explicit version constraint allowing its desired stability.

> **Note** If you want to customize table names, you must change the table names
> before running database migrations.
> See [Customizing Shield](./customization.md#custom-table-names).
> See [Customizing Table Names](./customization/table_names.md).

2. Configure **app/Config/Email.php** to allow Shield to send emails with the [Email Class](https://codeigniter.com/user_guide/libraries/email.html).

Expand Down Expand Up @@ -140,7 +140,7 @@ your project.

> **Note** If you want to customize table names, you must change the table names
> before running database migrations.
> See [Customizing Shield](./customization.md#custom-table-names).
> See [Customizing Table Names](./customization/table_names.md).

```console
php spark migrate --all
Expand Down
6 changes: 3 additions & 3 deletions docs/quick_start_guide/authentication_flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public int $unusedTokenLifetime = YEAR;
### Enable Account Activation via Email

> **Note**
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](../install.md#initial-setup).
By default, once a user registers they have an active account that can be used. You can enable Shield's built-in, email-based activation flow within the `Auth` config file.

Expand All @@ -63,7 +63,7 @@ public array $actions = [
### Enable Two-Factor Authentication

> **Note**
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](../install.md#initial-setup).
Turned off by default, Shield's Email-based 2FA can be enabled by specifying the class to use in the `Auth` config file.

Expand All @@ -77,7 +77,7 @@ public array $actions = [
## Responding to Magic Link Logins

> **Note**
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](install.md#initial-setup).
> You need to configure **app/Config/Email.php** to allow Shield to send emails. See [Installation](../install.md#initial-setup).
Magic Link logins allow a user that has forgotten their password to have an email sent with a unique, one-time login link. Once they've logged in you can decide how to respond. In some cases, you might want to redirect them to a special page where they must choose a new password. In other cases, you might simply want to display a one-time message prompting them to go to their account page and choose a new password.

Expand Down
2 changes: 1 addition & 1 deletion docs/quick_start_guide/managing_users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Managing Users

Since Shield uses a more complex user setup than many other systems, separating [User Identities](concepts.md#user-identities) from the user accounts themselves. This quick overview should help you feel more confident when working with users on a day-to-day basis.
Since Shield uses a more complex user setup than many other systems, separating [User Identities](../concepts.md#user-identities) from the user accounts themselves. This quick overview should help you feel more confident when working with users on a day-to-day basis.

## Creating Users

Expand Down

0 comments on commit 7664dcb

Please sign in to comment.