Skip to content

Commit 6dc1ca2

Browse files
authored
Fixed some grammar and spelling mistakes in the docs. (#895)
1 parent a3c085e commit 6dc1ca2

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/getting_started.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ That’ll create a directory :file:`users`, which is laid out like this::
8282
If you’re starting a new project, it’s highly recommended to set up a custom user model, even if the default `User`_ model is sufficient for you. This model behaves identically to the default user model, but you’ll be able to customize it in the future if the need arises.
8383
-- `Django documentation`_
8484

85-
Edit :file:`users/models.py` adding the code bellow:
85+
Edit :file:`users/models.py` adding the code below:
8686

8787
.. code-block:: python
8888
@@ -105,7 +105,7 @@ Change :file:`iam/settings.py` to add ``users`` application to ``INSTALLED_APPS`
105105
'users',
106106
]
107107
108-
Configure ``users.User`` to be the model used for the ``auth`` application adding ``AUTH_USER_MODEL`` to :file:`iam/settings.py`:
108+
Configure ``users.User`` to be the model used for the ``auth`` application by adding ``AUTH_USER_MODEL`` to :file:`iam/settings.py`:
109109

110110
.. code-block:: python
111111
@@ -152,7 +152,7 @@ The ``migrate`` output::
152152
Django OAuth Toolkit
153153
--------------------
154154

155-
Django OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2 capabilities to your Django projects.
155+
Django OAuth Toolkit can help you by providing, out of the box, all the endpoints, data, and logic needed to add OAuth2 capabilities to your Django projects.
156156

157157
Install Django OAuth Toolkit::
158158

@@ -231,12 +231,12 @@ We will start by given a try to the grant types listed below:
231231
* Authorization code
232232
* Client credential
233233

234-
This two grant types cover the most initially used uses cases.
234+
These two grant types cover the most initially used use cases.
235235

236236
Authorization Code
237237
------------------
238238

239-
The Authorization Code flow is best used in web and mobile apps. This is the flow used for third party integration, the user authorize your partner to access its products in your APIs.
239+
The Authorization Code flow is best used in web and mobile apps. This is the flow used for third party integration, the user authorizes your partner to access its products in your APIs.
240240

241241
Start the development server::
242242

@@ -256,7 +256,7 @@ Export ``Client id`` and ``Client secret`` values as environment variable:
256256
export ID=vW1RcAl7Mb0d5gyHNQIAcH110lWoOW2BmWJIero8
257257
export SECRET=DZFpuNjRdt5xUEzxXovAp40bU3lQvoMvF3awEStn61RXWE0Ses4RgzHWKJKTvUCHfRkhcBi3ebsEfSjfEO96vo2Sh6pZlxJ6f7KcUbhvqMMPoVxRwv4vfdWEoWMGPeIO
258258

259-
To start the Authorization code flow got to this `URL`_ with is the same as show bellow::
259+
To start the Authorization code flow go to this `URL`_ which is the same as shown below::
260260

261261
http://127.0.0.1:8000/o/authorize/?response_type=code&client_id=vW1RcAl7Mb0d5gyHNQIAcH110lWoOW2BmWJIero8&redirect_uri=http://127.0.0.1:8000/noexist/callback
262262

@@ -273,13 +273,13 @@ Go ahead and authorize the ``web-app``
273273
.. image:: _images/application-authorize-web-app.png
274274
:alt: Authorization code authorize web-app
275275

276-
Remenber we used ``http://127.0.0.1:8000/noexist/callback`` as ``redirect_uri`` you will get a **Page not found (404)** but it worked if you get a url like::
276+
Remember we used ``http://127.0.0.1:8000/noexist/callback`` as ``redirect_uri`` you will get a **Page not found (404)** but it worked if you get a url like::
277277

278278
http://127.0.0.1:8000/noexist/callback?code=uVqLxiHDKIirldDZQfSnDsmYW1Abj2
279279

280-
This is the OAuth2 provider trying to give you a ``code`` in this case ``uVqLxiHDKIirldDZQfSnDsmYW1Abj2``.
280+
This is the OAuth2 provider trying to give you a ``code``. in this case ``uVqLxiHDKIirldDZQfSnDsmYW1Abj2``.
281281

282-
Export it as environment variable:
282+
Export it as an environment variable:
283283

284284
.. code-block:: sh
285285
@@ -326,7 +326,7 @@ The Client Credential grant is suitable for machine-to-machine authentication. Y
326326

327327
Point your browser to http://127.0.0.1:8000/o/applications/register/ lets create an application.
328328

329-
Fill the form as show in the screenshot bellow and before save take note of ``Client id`` and ``Client secret`` we will use it in a minute.
329+
Fill the form as show in the screenshot below, and before saving take note of ``Client id`` and ``Client secret`` we will use it in a minute.
330330

331331
.. image:: _images/application-register-client-credential.png
332332
:alt: Client credential application registration
@@ -352,7 +352,7 @@ We need to encode ``client_id`` and ``client_secret`` as HTTP base authenticatio
352352
b'YXhYU1NCVnV2T3lHVnpoNFB1cnZLYXE1TUhYTW03RnRySGdETWk0dToxZnV2NVdWZlI3QTVCbEYwbzE1NUg3czViTGdYbHdXTGhpM1k3cGRKOWFKdUNkbDBYVjVDeGdkMHRyaTduU3pDODBxeXJvdmg4cUZYRkhnRkFBYzBsZFBObjVaWUxhbnhTbTFTSTFyeGxScldVUDU5MXdwSERHYTNwU3BCNmRDWg=='
353353
>>>
354354
355-
Export the credential as environment variable
355+
Export the credential as an environment variable
356356

357357
.. code-block:: sh
358358
@@ -362,7 +362,7 @@ To start the Client Credential flow you call ``/token/`` endpoint direct::
362362

363363
curl -X POST -H "Authorization: Basic ${CREDENTIAL}" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" "http://127.0.0.1:8000/o/token/" -d "grant_type=client_credentials"
364364

365-
To be more easy to visualize::
365+
To be easier to visualize::
366366

367367
curl -X POST \
368368
-H "Authorization: Basic ${CREDENTIAL}" \
@@ -371,7 +371,7 @@ To be more easy to visualize::
371371
"http://127.0.0.1:8000/o/token/" \
372372
-d "grant_type=client_credentials"
373373

374-
The OAuth2 provider will return the follow response:
374+
The OAuth2 provider will return the following response:
375375

376376
.. code-block:: javascript
377377

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Welcome to Django OAuth Toolkit Documentation
77
=============================================
88

9-
Django OAuth Toolkit can help you providing out of the box all the endpoints, data and logic needed to add OAuth2
9+
Django OAuth Toolkit can help you by providing, out of the box, all the endpoints, data, and logic needed to add OAuth2
1010
capabilities to your Django projects. Django OAuth Toolkit makes extensive use of the excellent
1111
`OAuthLib <https://github.com/idan/oauthlib>`_, so that everything is
1212
`rfc-compliant <http://tools.ietf.org/html/rfc6749>`_.

0 commit comments

Comments
 (0)