docs: rename provider module to module provider (#7869)

* docs: rename provider module to module provider

* fix vale rule

* vale fixes
This commit is contained in:
Shahed Nasser
2024-07-01 10:21:19 +03:00
committed by GitHub
parent 2833e3c4d0
commit 1842cd33cf
28 changed files with 117 additions and 117 deletions
@@ -1,22 +1,22 @@
import { Table } from "docs-ui"
export const metadata = {
title: `Google Auth Provider Module`,
title: `Google Auth Module Provider`,
}
# {metadata.title}
In this document, youll learn about the Google auth provider module and how to install and use it in the Auth Module.
In this document, youll learn about the Google auth module provider and how to install and use it in the Auth Module.
## Features
The Google auth provider module handles authenticating users with their Google accounts.
The Google auth module provider handles authenticating users with their Google accounts.
By integrating the Google auth provider, you provide your users and customers with the ability to login with their Google account.
---
## Install the Google Auth Provider Module
## Install the Google Auth Module Provider
<Note type="check">
@@ -28,7 +28,7 @@ By integrating the Google auth provider, you provide your users and customers wi
</Note>
To install the Google auth provider module, run the following command in the directory of your Medusa application:
To install the Google auth module provider, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/auth-google
@@ -1,20 +1,20 @@
import { Table } from "docs-ui"
export const metadata = {
title: `Emailpass Auth Provider Module`,
title: `Emailpass Auth Module Provider`,
}
# {metadata.title}
In this document, youll learn about the Emailpass auth provider module and how to install and use it in the Auth Module.
In this document, youll learn about the Emailpass auth module provider and how to install and use it in the Auth Module.
## Features
Using the Emailpass auth provider module, you allow users to register and login with an email and password.
Using the Emailpass auth module provider, you allow users to register and login with an email and password.
---
## Install the Emailpass Auth Provider Module
## Install the Emailpass Auth Module Provider
The Emailpass auth provider is registered by default with the Auth Module.
@@ -6,15 +6,15 @@ export const metadata = {
In this document, youll learn how the Auth Module handles authentication using providers.
## What's an Auth Provider Module?
## What's an Auth Module Provider?
An auth provider module handles authenticating customers and users, either using custom logic or by integrating a third-party service.
An auth module provider handles authenticating customers and users, either using custom logic or by integrating a third-party service.
For example, the EmailPass Auth Provider Module authenticates a user using their email and password, whereas the Google Auth Provider Module authenticates users using their Google account.
For example, the EmailPass Auth Module Provider authenticates a user using their email and password, whereas the Google Auth Module Provider authenticates users using their Google account.
<Note type="soon">
Support for the Google Auth Provider Module is coming soon.
Support for the Google Auth Module Provider is coming soon.
</Note>
@@ -22,7 +22,7 @@ Support for the Google Auth Provider Module is coming soon.
## Configure Allowed Auth Providers of Actor Types
By default, users of all actor types can authenticate with all installed auth provider moduless.
By default, users of all actor types can authenticate with all installed auth module providerss.
To restrict the auth providers used for actor types, use the [authMethodsPerActor option](/references/medusa-config#http-authMethodsPerActor-1-3) in Medusa's configurations:
@@ -49,6 +49,6 @@ When you specify the `authMethodsPerActor` configuration, it overrides the defau
---
## How to Create an Auth Provider Module
## How to Create an Auth Module Provider
Refer to [this guide](/references/auth/provider) to learn how to create an auth provider module.
Refer to [this guide](/references/auth/provider) to learn how to create an auth module provider.
@@ -14,7 +14,7 @@ In this document, you'll learn about the options of the Auth Module.
## providers
The `providers` option is an array of auth provider modules.
The `providers` option is an array of auth module providers.
When the Medusa application starts, these providers are registered and can be used to handle authentication.
@@ -49,9 +49,9 @@ module.exports = defineConfig({
The `providers` option is an array of objects that accept the following properties:
- `resolve`: A string indicating the package name of the auth provider module or the path to it.
- `options`: An optional object of the auth provider module's options. The object must have the following property:
- `config`: An object whose key is the ID of the auth provider, and its value is an object of options to pass to the provider module.
- `resolve`: A string indicating the package name of the module provider or the path to it.
- `options`: An optional object of the module provider's options. The object must have the following property:
- `config`: An object whose key is the ID of the auth provider, and its value is an object of options to pass to the module provider.
---