Skip to content

Commit 13241e6

Browse files
Merge pull request #5829 from mmafrar/fix/english-wording-typos
Fix: Correct English typos in Identity Server documentation
2 parents 1475b93 + d15a8ea commit 13241e6

File tree

67 files changed

+250
-236
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+250
-236
lines changed

en/asgardeo/docs/get-started/try-it-application.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The following guide explains how you can quickly test login with Asgardeo using
1010

1111
## Asgardeo Try It app
1212

13-
**Try It** is a test application that we have already set up and configured for you to quicky integrate authenticators and see how Asgardeo login works with applications.
13+
**Try It** is a test application that we have already set up and configured for you to quickly integrate authenticators and see how Asgardeo login works with applications.
1414

1515
Let's try a simple login flow in the Asgardeo Try It application:
1616

@@ -36,7 +36,7 @@ You can use the various authenticators Asgardeo offers to customize the login fl
3636
![Try It application]({{base_path}}/assets/img/get-started/custom-login-flow.png){: width="700" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
3737

3838
!!! note
39-
Follow the guides below to learn how to configure the authention flows.
39+
Follow the guides below to learn how to configure the authentication flows.
4040

4141
- [Add Social login]({{base_path}}/guides/authentication/social-login/)
4242
- [Add Passwordless login]({{base_path}}/guides/authentication/passwordless-login/)

en/asgardeo/docs/get-started/try-samples/qsg-saml-webapp-java-ee.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Follow these steps given below to register the sample Java EE web application in
3939
<td>Select <b>SAML</b>.</td>
4040
</tr>
4141
<tr>
42-
<td>Configruation type</td>
42+
<td>Configuration type</td>
4343
<td>Select <b>Manual</b> (Learn more about [SAML configuration types]({{base_path}}/guides/applications/register-saml-web-app/))</td>
4444
</tr>
4545
<tr>
@@ -57,7 +57,7 @@ Follow these steps given below to register the sample Java EE web application in
5757
</td>
5858
</tr>
5959
</table>
60-
5. Click **Register** to complete the registration.
60+
4. Click **Register** to complete the registration.
6161

6262
!!! tip
6363
To provide a better experience for the user, it is recommended to configure an access URL for the application. You can set an access URL from the **General** tab of the application. (For this sample application, the access URL is <code>https://localhost:8080/sample-app</code>).
@@ -99,7 +99,7 @@ Follow the steps given below to configure the sample app.
9999
This will extract the contents of the **war** file. </br>
100100
If your Tomcat server is set to auto-deploy applications, you can skip this step.
101101

102-
```bash
102+
```bash
103103
sh catalina.sh start
104104
```
105105

@@ -112,7 +112,7 @@ Follow the steps given below to configure the sample app.
112112
- Update the **SAML2.IdPEntityId** parameter with the Asgardeo issuer, which is `api.asgardeo.io/t/{organization_name}`.
113113
- **SAML2.SPEntityId** should match the issuer name entered when registering the application in Asgardeo.
114114

115-
```saml
115+
```saml
116116
SAML2.AssertionConsumerURL=http://localhost:8080/sample-app/home.jsp
117117
SAML2.SPEntityId=sample-issuer
118118
SAML2.IdPEntityId=api.asgardeo.io/t/{organization_name}
@@ -134,6 +134,7 @@ Follow the steps given below to configure the sample app.
134134
ErrorPage=/error.jsp
135135
SAML2SSOURL=samlsso
136136
```
137+
137138
<table>
138139
<thead>
139140
<tr>
@@ -287,7 +288,7 @@ Follow the steps given below to configure the sample app.
287288

288289
5. In the `{TOMCAT_HOME}/bin` folder, run the following commands to restart the Tomcat server for the configurations to take effect:
289290

290-
```bash
291+
```bash
291292
sh catalina.sh stop
292293
sh catalina.sh start
293294
```

en/asgardeo/docs/guides/asgardeo-logs/diagnostic-logs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ executeStep(1, {
6565
})
6666
...
6767
```
68+
6869
Once a user succeeds the first login step, the debug log appears in the logs portal as shown below.
6970

7071
![Debug logs in conditional authentication]({{base_path}}/assets/img/guides/asgardeo-logs/debug-log-conditional-auth.png){: width="550" style="border: 0.3px solid lightgrey;"}
@@ -78,12 +79,14 @@ Conditional authentication scripts can generate two types of error logs in the l
7879
- Application errors that occur due to syntax errors in the conditional authentication script.
7980

8081
For example, your conditional authentication script may have a syntax error that the editor does not flag as shown below.
82+
8183
```java
8284
.....
8385
var allowedGroups = ['Supplier'];
84-
Log.info('Allowed groups: ' + alowedGroups.toString());
86+
Log.info('Allowed groups: ' + allowedGroups.toString());
8587
.....
8688
```
89+
8790
Once a user attempts to log in, the error is logged in the logs portal as shown below.
8891

8992
![Error logs due to syntax in conditional authentication]({{base_path}}/assets/img/guides/asgardeo-logs/error-log-syntax-error-conditional-auth.png){: width="700" style="border: 0.3px solid lightgrey;"}
@@ -107,6 +110,7 @@ Conditional authentication scripts can generate two types of error logs in the l
107110
})
108111
...
109112
```
113+
110114
Once an unauthorized user attempts to log in, the error is logged in the logs portal as shown.
111115

112116
![Error logs in conditional authentication]({{base_path}}/assets/img/guides/asgardeo-logs/error-log-conditional-auth.png){: width="700" style="border: 0.3px solid lightgrey;"}

en/asgardeo/docs/guides/authentication/mfa/add-duo-login.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before you begin, ensure you have the following:
1313

1414
## Configure Duo Security Application
1515

16-
1. Log in to the [Duo Securty admin panel](https://admin.duosecurity.com/login).
16+
1. Log in to the [Duo Security admin panel](https://admin.duosecurity.com/login).
1717
2. Click **Applications** from the left panel and then click the **Protect an Application** button.
1818

1919
![Create duo security app]({{base_path}}/assets/img/guides/mfa/duo/add-duo-security-app.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
@@ -28,8 +28,8 @@ Before you begin, ensure you have the following:
2828

2929
Next, you need to register Duo as a connection in Asgardeo. To do so, follow the steps below.
3030

31-
1. Log in to the [Asgardeo Console](https://console.asgardeo.io/) as an adminstrator.
32-
2. Navigate to **Connections** from the left-hand panel
31+
1. Log in to the [Asgardeo Console](https://console.asgardeo.io/) as an administrator.
32+
2. Navigate to **Connections** from the left-hand panel
3333
3. Click **New Connection** and select **Duo** from the listed templates.
3434
4. Provide a Name for the Duo connection (e.g., "Duo Security").
3535
5. Enter the **Client ID**, **Client secret**, and **API hostname**, that you obtained from the Duo Admin Panel.
@@ -42,16 +42,16 @@ The created Duo connection should be added as an MFA option to the login flow of
4242
1. On the [Asgardeo Console](https://console.asgardeo.io/), navigate to **Applications**.
4343
2. Select the application for which you want to enable Duo MFA.
4444
3. Go to the **Login Flow** section. Username and Password will be added as the default login method.
45-
4. Click on the **+ icon** to add a new step to the login flow.
45+
4. Click on the **+ icon** to add a new step to the login flow.
4646
5. Click on the **+ Add Sign In Option** button in step 2.
47-
6. Select the Duo connection from the authenticator list and click **Add**.
47+
6. Select the Duo connection from the authenticator list and click **Add**.
4848
7. Save the changes by clicking the **Update** button.
4949

5050
## Test the Integration
5151

5252
Finally, you need to verify that Duo has been successfully integrated and is functioning correctly as a second-factor authentication method. To do so,
5353

54-
1. Access the sample application and click on **Login** button.
54+
1. Access the sample application and click on **Login** button.
5555

5656
![React sample app login]({{base_path}}/assets/img/guides/mfa/duo/react-sample-app-login.png){: style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
5757

en/identity-server/5.10.0/docs/develop/writing-a-custom-event-handler.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# Writing a Custom Event Handler
22

3-
The WSO2 Identity Server eventing framework can be used to trigger events such as user operation events like `PRE_SET_USER_CLAIMS`,`POST_ADD_USER`. A full list of the sample events can be found below. The eventing framework also supports handlers which can be used to do operations upon a triggered event. For instance, an event handler can be used to validate the changed user password against previously used entries when a `PRE_UPDATE_CREDENTIAL` event is triggered.
3+
The WSO2 Identity Server eventing framework can be used to trigger events such as user operation events like `PRE_SET_USER_CLAIMS`,`POST_ADD_USER`. A full list of the sample events can be found below. The eventing framework also supports handlers which can be used to do operations upon a triggered event. For instance, an event handler can be used to validate the changed user password against previously used entries when a `PRE_UPDATE_CREDENTIAL` event is triggered.
44

55
## What is an event handler?
66

7-
An event handler is used to perform an operation based on the published events.
7+
An event handler is used to perform an operation based on the published events.
88

99
For instance, an event handler can be used to send an email after a user addition. The following sequence of operations are executed while adding a user.
1010

1111
1. Publish the `PRE_ADD_USER` event — The subscribed handlers will be executed for the pre-add user event.
12-
2. Execute the `AddUser` operation — The user will be persisted to the user store (LDAP or JBDC user store).
12+
2. Execute the `AddUser` operation — The user will be persisted to the user store (LDAP or JDBC user store).
1313
3. Publish the `POST_ADD_USER` event — The subscribed handlers will be executed for the post-add user event.
1414

1515
Therefore, the email can be sent through an event handler that is subscribed to the `POST_ADD_USER` event.
1616

17-
The following list is a list of sample events.
17+
The following list is a list of sample events.
1818

1919
- `PRE_AUTHENTICATION`
2020
- `POST_AUTHENTICATION`
@@ -52,11 +52,11 @@ The following list is a list of sample events.
5252

5353
## Writing an event handler
5454

55-
To write a new event handler, you must extend the `org.wso2.carbon.identity.event.handler.AbstractEventHandler`.
55+
To write a new event handler, you must extend the `org.wso2.carbon.identity.event.handler.AbstractEventHandler`.
5656

57-
1. Override the `getName()` method to set the name for the event handler and the `getPriority()` method can be used to set the priory of the event handler. The handlers will be executed based on the priority.
57+
1. Override the `getName()` method to set the name for the event handler and the `getPriority()` method can be used to set the priority of the event handler. The handlers will be executed based on the priority.
5858

59-
```
59+
```java
6060
public String getName() {
6161
return "emailSender";
6262
}
@@ -67,9 +67,9 @@ To write a new event handler, you must extend the `org.wso2.carbon.identity.even
6767
}
6868
```
6969

70-
2. To execute the expected operation, override the `handleEvent()` method. The `event.getEventProperties()` method can be used to get the parameters related to the user operations.
70+
2. To execute the expected operation, override the `handleEvent()` method. The `event.getEventProperties()` method can be used to get the parameters related to the user operations.
7171

72-
```
72+
```java
7373
@Override
7474
public void handleEvent(Event event) throws IdentityEventException {
7575

@@ -83,11 +83,11 @@ To write a new event handler, you must extend the `org.wso2.carbon.identity.even
8383
String[] roleList = (String[]) eventProperties.get(IdentityEventConstants.EventProperty.ROLE_LIST);
8484
```
8585

86-
## Registering the event handler
86+
## Registering the event handler
8787

8888
Register the event handler in the service component as follows.
8989

90-
```
90+
```java
9191
protected void activate(ComponentContext context) {
9292
try {
9393
BundleContext bundleContext = context.getBundleContext();
@@ -102,7 +102,7 @@ class.getName(),new SampleEventHandler(), null);
102102

103103
Add the event handler configuration to the `<IS_HOME>/repository/conf/deployment.toml` file. The events that need to subscribe to the handler can be listed in subscriptions.
104104

105-
```
105+
```toml
106106
[[event_handler]]
107107
name= "emailSender"
108108
subscriptions =["POST_ADD_USER"]

en/identity-server/5.10.0/docs/setup/changing-datasource-consent-management.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Changing the Default Datasource for Consent Management
22

3-
WSO2 Identity Server is shipped with an embedded H2 database for storing data.
4-
These default databases are located in the `<IS_HOME>/repository/database` directory
3+
WSO2 Identity Server is shipped with an embedded H2 database for storing data.
4+
These default databases are located in the `<IS_HOME>/repository/database` directory
55
of the product pack.
66

7-
By default Consent Management data is stored in the identity database (IDENTITY_DB) with
8-
Identity and UMA data. However, you can separate consent specific data into a separate
7+
By default Consent Management data is stored in the identity database (IDENTITY_DB) with
8+
Identity and UMA data. However, you can separate consent specific data into a separate
99
data-source to any database type that is supported by WSO2 Identity Server.
1010

1111
!!! note
12-
For more information about databases, see
13-
[Working with Databases](../../setup/working-with-databases) and
12+
For more information about databases, see
13+
[Working with Databases](../../setup/working-with-databases) and
1414
[Setting Up Separate Databases for Clustering](../../setup/setting-up-separate-databases-for-clustering).
1515

1616
Following are the sample configuration for each database type.
@@ -26,7 +26,7 @@ Following are the sample configuration for each database type.
2626
driver = "org.postgresql.Driver"
2727
jmx_enable=false
2828
```
29-
29+
3030
2. Executing database scripts.
3131

3232
Navigate to `<IS-HOME>/dbscripts`. Execute the scripts in the following file, against
@@ -45,7 +45,7 @@ Following are the sample configuration for each database type.
4545
driver = "com.mysql.jdbc.Driver"
4646
jmx_enable=false
4747
```
48-
48+
4949
2. Executing database scripts.
5050

5151
Navigate to `<IS-HOME>/dbscripts`. Execute the scripts in the following file, against
@@ -64,7 +64,7 @@ Following are the sample configuration for each database type.
6464
driver = "com.ibm.db2.jcc.DB2Driver"
6565
jmx_enable=false
6666
```
67-
67+
6868
2. Executing database scripts.
6969

7070
Navigate to `<IS-HOME>/dbscripts`. Execute the scripts in the following file, against
@@ -83,7 +83,7 @@ Following are the sample configuration for each database type.
8383
driver = "com.microsoft.sqlserver.jdbc.SQLServerDriver"
8484
jmx_enable=false
8585
```
86-
86+
8787
2. Executing database scripts.
8888

8989
Navigate to `<IS-HOME>/dbscripts`. Execute the scripts in the following file, against
@@ -102,7 +102,7 @@ Following are the sample configuration for each database type.
102102
driver = "oracle.jdbc.OracleDriver"
103103
jmx_enable=false
104104
```
105-
105+
106106
2. Executing database scripts.
107107

108108
Navigate to `<IS-HOME>/dbscripts`. Execute the scripts in the following file, against
@@ -226,7 +226,7 @@ as a single transaction.</p>
226226

227227

228228
Once when we separate out consent database from `WSO2IdentityDB`, we need to add the
229-
following configuration to the `deployement.toml` to specify WSO2 Identity Server to
229+
following configuration to the `deployment.toml` to specify WSO2 Identity Server to
230230
use a separate data-source instead of default `IDENTITY_DB`.
231231

232232
```
@@ -259,4 +259,4 @@ data_source="jdbc/WSO2CONSENT_DB"
259259

260260
[authentication.consent]
261261
data_source="jdbc/WSO2CONSENT_DB"
262-
```
262+
```

en/identity-server/5.10.0/docs/setup/jmx-based-monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ monitor the performance of the datasource using this MBean. The
274274
![](../assets/img/53125400/57747100.png)
275275

276276
**Example:** If you have JMX enabled for the default Carbon datasources
277-
in the ` deployement.toml ` file, the [JDBC connection pool
277+
in the ` deployment.toml ` file, the [JDBC connection pool
278278
parameters](http://tomcat.apache.org/tomcat-9.0-doc/jdbc-pool.html) that
279279
are configured for the Carbon datasource will be listed as attributes as
280280
shown below. See the

0 commit comments

Comments
 (0)