Skip to content

Commit a0efb6b

Browse files
nnixaayggg
authored andcommitted
fix(docs): articles grammar (#1810)
1 parent 3bba9e2 commit a0efb6b

19 files changed

+55
-117
lines changed

docs/articles/auth/azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuring Azure OAuth2 with Nebular Auth
22

3-
Using `NbOAuth2AuthStrategy` gives possibility to configure authentication with a lot of 3rd party authentication providers, such as Azure in our example.
3+
Using `NbOAuth2AuthStrategy` gives the possibility to configure authentication with a lot of 3rd party authentication providers, such as Azure in our example.
44
There is no need in any backend implementation, as [OAuth2](https://tools.ietf.org/html/rfc6749) protocol enables completely server-less authentication flow as one of the options.
55

66
## Complete example

docs/articles/auth/custom-ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export class NgxAuthModule {
8080

8181
```
8282

83-
A couple of required modules for the future components. Also, notice how we imported the `NbAuthModule` but without the `forRoot` call.
83+
A couple of required modules for future components. Also, notice how we imported the `NbAuthModule` but without the `forRoot` call.
8484
This way we imported the declared auth components, such as for example `NbAuthBlock`, so we can use it inside of our components.
8585

8686
Now, let's fill in the routing file:

docs/articles/auth/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import { NbPasswordAuthStrategy, NbAuthModule } from '@nebular/auth';
4747
4848
## Configure a strategy
4949
50-
Now, let's configure the module by specifying available strategies, in our case we add `NbPasswordAuthStrategy`.
50+
Now, let's configure the module by specifying available strategies, in our case, we add `NbPasswordAuthStrategy`.
5151
To add a strategy we need to call static `setup` method to pass a list of options:
5252
5353
```ts

docs/articles/auth/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Auth Module
22

3-
The main goal of the Auth module is to provide a pluggable set of components and services for an easier setup of the authentication layer for Angular applications.
3+
The main goal of the Auth module is to provide a pluggable set of components and services for easier setup of the authentication layer for Angular applications.
44
The module separates the UI part (login/register/etc components) from the business logic with the help of the authentication `Strategies` layer.
55

66
<div class="note note-info">
@@ -22,7 +22,7 @@ You can use the built-in components or create your custom ones.
2222
<hr>
2323

2424
## Auth Strategies
25-
- `NbDummyAuthStrategy` - simple strategy for testing purposes, could be used for simulating backend responses while API is in the development;
25+
- `NbDummyAuthStrategy` - a simple strategy for testing purposes, could be used for simulating backend responses while API is in the development;
2626
- `NbPasswordAuthStrategy` - the most common email/login/password authentication strategy.
2727
- `NbOAuth2AuthStrategy` - the most popular authentication framework that enables applications to obtain limited access to user accounts on HTTP service.
2828
<hr>

docs/articles/auth/oauth2.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Configuring Google OAuth2 with Nebular Auth
22

3-
Using `NbOAuth2AuthStrategy` gives possibility to configure authentication with a lot of 3rd party authentication providers, such as Google, Facebook, etc.
3+
Using `NbOAuth2AuthStrategy` gives the possibility to configure authentication with a lot of 3rd party authentication providers, such as Google, Facebook, etc.
44
There is no need in any backend implementation, as [OAuth2](https://tools.ietf.org/html/rfc6749) protocol enables completely server-less authentication flow as one of the options.
55

66
In this article we will setup and configure `NbOAuth2AuthStrategy` for [Google Authentication](https://developers.google.com/identity/protocols/OAuth2UserAgent)
@@ -9,9 +9,9 @@ based on [Implicit](https://tools.ietf.org/html/rfc6749#section-4.2) flow.
99

1010
## Step 1. Obtain keys
1111

12-
As a first step we need to setup an application and obtain its keys on the authentication server (Google in our case).
12+
As a first step, we need to set up an application and obtain its keys on the authentication server (Google in our case).
1313
More details how to do this you can find on [Enable APIs for your project](https://developers.google.com/identity/protocols/OAuth2UserAgent#enable-apis) page.
14-
We won't copy over this part of the article here, but as a result you should have your `client_id` - unique application identifier.
14+
We won't copy over this part of the article here, but as a result, you should have your `client_id` - unique application identifier.
1515
<hr>
1616

1717
## Step 2. Enable a Strategy
@@ -38,7 +38,7 @@ export class YourModule {
3838
```
3939

4040
So we imported `NbAuthModule` and provided a strategy we want to use. If you already have some strategy configurated - don't worry, you can just add a new one to the `strategies` array.
41-
We also assigned a `name` - `google`. Later on we will use this alias to call the strategy.
41+
We also assigned a `name` - `google`. Later on, we will use this alias to call the strategy.
4242
<hr>
4343

4444
## Step 3. Configure
@@ -74,7 +74,7 @@ export class YourModule {
7474

7575
## Step 4. Routes
7676

77-
We need at least two routes to be able to organize OAuth2 flow. First one - "login" route, where we can simply have a button to initiate authentication process.
77+
We need at least two routes to be able to organize OAuth2 flow. First one - "login" route, where we can simply have a button to initiate the authentication process.
7878
The second one - so-called "callback" route, we need to handle OAuth2 server response.
7979
Let's add both to our routing referring some empty components:
8080

@@ -94,7 +94,7 @@ RouterModule.forChild([
9494

9595
## Step 5. Redirect URI
9696

97-
The last configuration bit is to setup the `redirect_uri` parameter. Make sure you've added the url to the Google Console as per the [documentation](https://developers.google.com/identity/protocols/OAuth2UserAgent#redirecting).
97+
The last configuration bit is to set up the `redirect_uri` parameter. Make sure you've added the URL to the Google Console as per the [documentation](https://developers.google.com/identity/protocols/OAuth2UserAgent#redirecting).
9898

9999
Now let's complete the setup:
100100
```ts
@@ -155,9 +155,9 @@ export class NbOAuth2LoginComponent implements OnDestroy {
155155
}
156156
```
157157
The code is pretty much straightforward - we call `NbAuthService`.`authenticate` method and pass our strategy alias - `google` subscribing to result.
158-
This will prepare `authorization` request url and redirect us to google authentication server.
158+
This will prepare `authorization` request URL and redirect us to google authentication server.
159159

160-
Now, we need to configure that "callback" url to be able to properly handle response:
160+
Now, we need to configure that "callback" URL to be able to properly handle response:
161161

162162
```ts
163163
@Component({
@@ -187,7 +187,7 @@ export class NbOAuth2CallbackPlaygroundComponent implements OnDestroy {
187187
}
188188
}
189189
```
190-
Here we call the same `authenticate` method, which will determines that we are in the `redirect` state, handle the response, save your token and redirect you back to your app.
190+
Here we call the same `authenticate` method, which will determine that we are in the `redirect` state, handle the response, save your token and redirect you back to your app.
191191
<hr>
192192

193193
## Complete example

docs/articles/auth/redirect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Redirecting user after login/registration
44

5-
At this step, we assume that Nebular Auth module is up and running,
5+
At this step, we assume that the Nebular Auth module is up and running,
66
you have successfully configured an auth strategy and adjusted auth look & fell accordingly with your requirements.
77

88
By default, Nebular redirects to the `/` page on success, and stays on the same page on error.

docs/articles/auth/strategy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ In Nebular terms `Auth Strategy` is a class containing authentication logic spec
44
It accepts user input (login/email/password/token/etc), communicates the input to the backend API and finally provides the resulting output back to the Auth UI layer.
55
Currently, there are two Auth Strategies available out of the box:
66

7-
- `NbDummyAuthStrategy` - simple strategy for testing purposes, could be used to simulate backend responses while API is in the development;
7+
- `NbDummyAuthStrategy` - a simple strategy for testing purposes, could be used to simulate backend responses while API is in the development;
88
- `NbPasswordAuthStrategy` - the most common email/password authentication strategy.
99

1010
Each Strategy has a list of configurations available with the default values set. But you can adjust the settings based on your requirements.
1111
<hr>
1212

1313
## Configure a strategy
1414

15-
As an example, let's configure API endpoints for the `NbPasswordAuthStrategy`. The strategy is configured by default, please take a look at the [default configuration values](docs/auth/nbpasswordauthstrategy) if you need any custom behaviour.
15+
As an example, let's configure API endpoints for the `NbPasswordAuthStrategy`. The strategy is configured by default, please take a look at the [default configuration values](docs/auth/nbpasswordauthstrategy) if you need any custom behavior.
1616
We assume you already have the Auth module installed inside of your `*.module.ts`:
1717

1818

@@ -34,7 +34,7 @@ We assume you already have the Auth module installed inside of your `*.module.ts
3434
});
3535

3636
```
37-
`email` here is an alias we've assigned to the strategy, so that we can dynamically mention it later. This also allows us to configure multiple strategies with various configurations in one app.
37+
`email` here is an alias we've assigned to the strategy so that we can dynamically mention it later. This also allows us to configure multiple strategies with various configurations in one app.
3838
<hr>
3939

4040
## Setup API configuration

docs/articles/auth/token.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
## Receiving user token after login/registration
44

5-
At this step, we assume that Nebular Auth module is up and running,
5+
At this step, we assume that the Nebular Auth module is up and running,
66
you have successfully configured an auth strategy and adjusted auth look & fell accordingly with your requirements.
77

8-
It's time to get a user token after successful authentication to be able to communicate with the server and, for instance, show a username in the header of the application.
9-
Let's assume that your backend returns a JWT token so that we can use the token payload to extract a user info out of it.
8+
It's time to get a user token after a successful authentication to be able to communicate with the server and, for instance, show username in the header of the application.
9+
Let's assume that your backend returns a JWT token so that we can use the token payload to extract user info out of it.
1010

1111
Each `Strategy` specifies which token class is going to be used by default. For example, `NbPasswordAuthStrategy` uses `NbAuthSimpleToken`,
1212
and `NbOAuth2AuthProvider` uses `NbAuthOAuth2Token`. It is also possible to specify another token class if it is required, like in the example below.
1313
<hr>
1414

15-
## Configure token type
15+
## Configure the token type
1616

1717
Let's tell Nebular that we are waiting for a JWT token instead of a simple string token.
1818
We just need to provide a respective class to do that. Open your `app.module.ts` and adjust your `Strategy` configuration:
@@ -85,13 +85,13 @@ We'll assume that our API returns a token as just `{ token: 'some-jwt-token' }`
8585

8686
## Use token
8787

88-
Okay, let's use the token to extract a payload and show a username in the header. Open your `header.component.ts` and import the following services:
88+
Okay, let's use the token to extract a payload and show username in the header. Open your `header.component.ts` and import the following services:
8989

9090
```typescript
9191
import { NbAuthJWTToken, NbAuthService } from '@nebular/auth';
9292
```
9393

94-
Then, let's create `user` variable, which will store the token payload inside of the component:
94+
Then, let's create a `user` variable, which will store the token payload inside of the component:
9595

9696
```typescript
9797

docs/articles/getting-started/professional-services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Professional Services
22
Evolve your products and apps to expand your markets. Nebular Services are set to help speed up the evolution of your business.
3-
The Nebular team is ready to bring you their expertise with following services.
3+
The Nebular team is ready to bring you their expertise with the following services.
44

55
### Theme customization
66
Let Akveo’s experts help you get more out of your Nebular experience. Modify, extend, and tailor Nebular components and controls to fit your needs. Our developers know the products inside and out, so there's no need to spend hours searching for a solution. We create themes, modules, and components to match your company branding.

docs/articles/getting-started/what-is-nebular.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Nebular is a customizable Angular UI Library based on [Eva Design System](https:
88
Nebular modules are distributed as separated `npm` packages:
99

1010
- Nebular Theme `@nebular/theme`
11-
- Theme - 4 visual themes, customizable theming engine with custom css properties support.
12-
- UI Components - high quality Angular components no 3rd party dependencies.
11+
- Theme - 4 visual themes, a customizable theming engine with custom css properties support.
12+
- UI Components - high-quality Angular components no 3rd party dependencies.
1313
- Server-side rendering compatibility.
1414
- Right-to-left writing system support for all components.
1515
- Nebular Auth `@nebular/auth`

docs/articles/getting-started/where-to-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ it is highly recommended to go through the Angular tutorial beforehand and be fa
77

88
## Quickstart tutorials
99

10-
Based on current setup of your project and your goals, there are two starting points:
10+
Based on the current setup of your project and your goals, there are two starting points:
1111

1212
- [Install Nebular](docs/guides/install-nebular) This tutorial explains how to use Nebular from scratch or if you already have some Angular code.
1313
- [Starting based on our Nebular Admin starter kit](docs/guides/install-based-on-starter-kit) Consider this tutorial if you are building admin or any other back-office application and you need a template as a good starting kit.

docs/articles/guides/backend-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section describes approaches of integration of Nebular application with bac
77

88
Despite there's an option to do CORS requests to API server directly, we don't advise to do so. This way has disadvantages in terms of security and performance. In terms of security when you do CORS request you basically expose your API server URL to everybody. Your API server should take additional measures to make sure some URLs are not accessible, because it is exposed to the web. As for performance, CORS requests require to send preflight OPTIONS request before each HTTP request. This adds additional HTTP overhead.
99

10-
The solution we suggest is to use proxy for your API server. In this case you can make your app accessible through some sub-url. For example, if your application's hosted under url `website.com` and your index file is located at `website.com/index.html`, you can make your API root accessible on `website.com/api`. This is well supported by angular-cli/webpack-dev-server for development setup and by web servers for production setup. Let's review these setups:
10+
The solution we suggest is to use a proxy for your API server. In this case, you can make your app accessible through some sub-url. For example, if your application's hosted under url `website.com` and your index file is located at `website.com/index.html`, you can make your API root accessible on `website.com/api`. This is well supported by angular-cli/webpack-dev-server for development setup and by web servers for production setup. Let's review these setups:
1111
<hr>
1212

1313
## angular-cli/webpack-dev-server setup
@@ -25,9 +25,9 @@ You should create `proxy.conf.json` file in your application root. The file shou
2525
}
2626
```
2727

28-
In this case you should put URL of your API server instead of `http://localhost:3000`.
28+
In this case, you should put URL of your API server instead of `http://localhost:3000`.
2929

30-
After that you need to run your angular-cli application using following command
30+
After that, you need to run your angular-cli application using the following command
3131
```bash
3232
ng serve --proxy-config proxy.conf.json
3333
```
@@ -36,9 +36,9 @@ That's it. Now you can access `/api` URL from your Nebular application and your
3636

3737
## Production setup
3838

39-
Production setup is not much different from development setup. The only difference is that usually you don't use there angular-cli or webpack-dev-server to host your HTML/CSS/JS. Usually we all use some web server for that. At Akveo we mostly use [nginx](https://nginx.org/en/) for this use case. Below there is a sample configuration for this particular web server. For others it is not that much different.
39+
Production setup is not much different from the development setup. The only difference is that usually, you don't use there angular-cli or webpack-dev-server to host your HTML/CSS/JS. Usually, we all use some web server for that. At Akveo we mostly use [nginx](https://nginx.org/en/) for this use case. Below there is a sample configuration for this particular web server. For others, it is not that much different.
4040

41-
Usually you create new virtual host with some similar configuration:
41+
Normally, you create a new virtual host with some similar configuration:
4242

4343
```nginx
4444
server {

docs/articles/guides/bootstrap-integration.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/articles/guides/custom-icons.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Register Icon pack
22

33
Nebular comes with an `<nb-icon></nb-icon>` component that accepts an `icon="icon-name"` and `pack="icon-pack"` parameters.
4-
By default, Nebular includes only small and limited pack called `nebular-essentials`. This pack consists of essential icons, such as `close-outline`, `checkmark-outline`, etc that are required by the Nebular components (modals, accordions, etc).
4+
5+
By default, Nebular includes only a small and limited pack called `nebular-essentials`. This pack consists of essential icons, such as `close-outline`, `checkmark-outline`, etc that are required by the Nebular components (modals, accordions, etc).
56

67
## Eva Icons
78

@@ -63,7 +64,8 @@ Then simply register the pack using `NbIconLibraries` service in you `app.compon
6364
<nb-icon icon="star" pack="font-awesome"></nb-icon>
6465
```
6566

66-
Lastly we can set this pack as the default and not specify it implicitly while using `<nb-icon>`:
67+
68+
Lastly, we can set this pack as the default and not specify it implicitly while using `<nb-icon>`:
6769
```ts
6870
import { NbIconLibraries } from '@nebular/theme';
6971

0 commit comments

Comments
 (0)