Skip to content

Commit fdd5bcb

Browse files
authored
Merge pull request #839 from kenjis/docs-reorganize
docs: reorganize (part 1)
2 parents 424b2cb + 8115054 commit fdd5bcb

25 files changed

+661
-791
lines changed

docs/auth_actions.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Authentication Actions
22

3-
- [Authentication Actions](#authentication-actions)
4-
- [Configuring Actions](#configuring-actions)
5-
- [Defining New Actions](#defining-new-actions)
6-
73
Authentication Actions are a way to group actions that can happen after login or registration.
84
Shield ships with two actions you can use, and makes it simple for you to define your own.
95

docs/authentication.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,5 @@
11
# Authentication
22

3-
- [Authentication](#authentication)
4-
- [Available Authenticators](#available-authenticators)
5-
- [Auth Helper](#auth-helper)
6-
- [Authenticator Responses](#authenticator-responses)
7-
- [isOK()](#isok)
8-
- [reason()](#reason)
9-
- [extraInfo()](#extrainfo)
10-
- [Session Authenticator](#session-authenticator)
11-
- [attempt()](#attempt)
12-
- [check()](#check)
13-
- [loggedIn()](#loggedin)
14-
- [logout()](#logout)
15-
- [forget()](#forget)
16-
- [Access Token Authenticator](#access-token-authenticator)
17-
- [Access Token/API Authentication](#access-tokenapi-authentication)
18-
- [Generating Access Tokens](#generating-access-tokens)
19-
- [Revoking Access Tokens](#revoking-access-tokens)
20-
- [Retrieving Access Tokens](#retrieving-access-tokens)
21-
- [Access Token Lifetime](#access-token-lifetime)
22-
- [Access Token Scopes](#access-token-scopes)
23-
- [HMAC SHA256 Token Authenticator](#hmac-sha256-token-authenticator)
24-
- [HMAC Keys/API Authentication](#hmac-keysapi-authentication)
25-
- [Generating HMAC Access Keys](#generating-hmac-access-keys)
26-
- [Revoking HMAC Keys](#revoking-hmac-keys)
27-
- [Retrieving HMAC Keys](#retrieving-hmac-keys)
28-
- [HMAC Keys Lifetime](#hmac-keys-lifetime)
29-
- [HMAC Keys Scopes](#hmac-keys-scopes)
30-
313
Authentication is the process of determining that a visitor actually belongs to your website,
324
and identifying them. Shield provides a flexible and secure authentication system for your
335
web apps and APIs.

docs/authorization.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,5 @@
11
# Authorization
22

3-
- [Authorization](#authorization)
4-
- [Defining Available Groups](#defining-available-groups)
5-
- [Default User Group](#default-user-group)
6-
- [Defining Available Permissions](#defining-available-permissions)
7-
- [Assigning Permissions to Groups](#assigning-permissions-to-groups)
8-
- [Authorizing Users](#authorizing-users)
9-
- [can()](#can)
10-
- [inGroup()](#ingroup)
11-
- [hasPermission()](#haspermission)
12-
- [Authorizing via Routes](#authorizing-via-routes)
13-
- [Managing User Permissions](#managing-user-permissions)
14-
- [addPermission()](#addpermission)
15-
- [removePermission()](#removepermission)
16-
- [syncPermissions()](#syncpermissions)
17-
- [getPermissions()](#getpermissions)
18-
- [Managing User Groups](#managing-user-groups)
19-
- [addGroup()](#addgroup)
20-
- [removeGroup()](#removegroup)
21-
- [syncGroups()](#syncgroups)
22-
- [getGroups()](#getgroups)
23-
- [User Activation](#user-activation)
24-
- [Checking Activation Status](#checking-activation-status)
25-
- [Activating a User](#activating-a-user)
26-
- [Deactivating a User](#deactivating-a-user)
27-
283
Authorization happens once a user has been identified through authentication. It is the process of
294
determining what actions a user is allowed to do within your site.
305

docs/concepts.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
This document covers some of the base concepts used throughout the library.
44

5-
- [Shield Concepts](#shield-concepts)
6-
- [Repository State](#repository-state)
7-
- [Settings](#settings)
8-
- [User Providers](#user-providers)
9-
- [User Identities](#user-identities)
10-
- [Password Validators](#password-validators)
11-
125
## Repository State
136

147
Shield is designed so that the initial setup of your application can all happen in code with nothing required to be
@@ -28,7 +21,7 @@ on the standard Config class if nothing is found in the database.
2821
Shield has a model to handle user persistence. Shield calls this the "User Provider" class.
2922
A default model is provided for you by the `CodeIgniter\Shield\Models\UserModel` class.
3023

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

3326
## User Identities
3427

0 commit comments

Comments
 (0)