docs: removes unused files

payloadcms · Jan 2, 2021 · cd9b360 · cd9b360
1 parent 1f66667
commit cd9b360
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 33 deletions.
diff --git a/docs/Authentication/accessing-logged-in-user.mdx b/docs/Authentication/accessing-logged-in-user.mdx
diff --git a/docs/Authentication/overview.mdx b/docs/Authentication/overview.mdx
@@ -66,6 +66,11 @@ Once enabled, each document that is created within the Collection can be thought
 
 Successfully logging in returns a `JWT` (JSON web token) which is how a user will identify themselves to Payload. By providing this JWT via either an HTTP-only cookie or an `Authorization` header, Payload will automatically identify the user and add its user JWT data to the Express `req`, which is available throughout Payload including within access control, hooks, and more.
 
+<Banner type="success">
+  <strong>Tip:</strong><br/>
+  You can access the logged in user from access control functions and hooks via the Express <strong>req</strong>. The logged in user is automatically added as the <strong>user</strong> property.
+</Banner>
+
 ### HTTP-only cookies
 
 Payload `login`, `logout`, and `refresh` operations make use of HTTP-only cookies for authentication purposes. HTTP-only cookies are a highly secure method of storing identifiable data on a user's device so that Payload can automatically recognize a returning user until their cookie expires. They are totally protected from common XSS attacks and cannot be read at all via JavaScript in the browser.

diff --git a/docs/Authentication/security.mdx b/docs/Authentication/security.mdx
diff --git a/docs/Authentication/using-middleware.mdx b/docs/Authentication/using-middleware.mdx
@@ -1,7 +1,7 @@
 ---
 title: Using the Payload Auth Middleware
 label: Using the Middleware
-order: 50
+order: 40
 ---
 
 Talk about how to use `payload.authenticate()` outside of Payload - show examples
diff --git a/docs/Configuration/collections.mdx b/docs/Configuration/collections.mdx
@@ -12,14 +12,16 @@ It's often best practice to write your Collections in separate files and then im
 
 | Option           | Description  |
 | ---------------- | -------------|
-| `slug`           | Unique, URL-friendly string that will act as an identifier for this Collection. |
-| `labels`         | Singular and plural labels for use in identifying this Collection throughout Payload. |
-| `fields`         | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| `admin`          | Admin-specific configuration. See below for [more detail](/docs/collections#admin). |
-| `hooks`          | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/config#collection-hooks) |
-| `access`         | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/config/#collections) |
-| `auth`           | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation. |
-| `upload`         | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/uploads/config) documentation. |
+| **`slug`** *     | Unique, URL-friendly string that will act as an identifier for this Collection. |
+| **`fields`** *     | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| **`labels`**     | Singular and plural labels for use in identifying this Collection throughout Payload. |
+| **`admin`**      | Admin-specific configuration. See below for [more detail](/docs/collections#admin). |
+| **`hooks`**      | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/config#collection-hooks) |
+| **`access`**     | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/config/#collections) |
+| **`auth`**       | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation. |
+| **`upload`**     | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/uploads/config) documentation. |
+
+*\* An asterisk denotes that a property is required.*
 
 #### Simple collection example
 

diff --git a/docs/Configuration/globals.mdx b/docs/Configuration/globals.mdx
@@ -12,14 +12,14 @@ As with Collection configs, it's often best practice to write your Globals in se
 
 | Option           | Description  |
 | ---------------- | -------------|
-| `slug`           | Unique, URL-friendly string that will act as an identifier for this Global. |
-| `label`          | Singular label for use in identifying this Global throughout Payload. |
-| `fields`         | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| `admin`          | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options). |
-| `hooks`          | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/config#global-hooks) |
-| `access`         | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/config/#globals) |
-| `auth`           | Specify options if you would like this collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation. |
-| `upload`         | Specify options if you would like this collection to support file uploads. For more, consult the [Uploads](/docs/uploads/config) documentation. |
+| **`slug`** *     | Unique, URL-friendly string that will act as an identifier for this Global. |
+| **`fields`** *   | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| **`label`**      | Singular label for use in identifying this Global throughout Payload. |
+| **`admin`**      | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options). |
+| **`hooks`**      | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/config#global-hooks) |
+| **`access`**     | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/config/#globals) |
+
+*\* An asterisk denotes that a property is required.*
 
 #### Simple Global example