Skip to content

Commit

Permalink
docs: fix grammar issues and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
wanderer163 authored and arpitpandey0209 committed Nov 7, 2021
1 parent 41f6187 commit 282c269
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 23 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ a few things you can do to help out:

- **Give us a star.** It may not seem like much, but it really makes a
difference. This is something that everyone can do to help out Ory Hydra.
Github stars help the project gain visibility and stand out.
GitHub stars help the project gain visibility and stand out.

- **Join the community.** Sometimes helping people can be as easy as listening
to their problems and offering a different perspective. Join our Slack, have a
Expand Down Expand Up @@ -147,13 +147,13 @@ request, go through this checklist:
1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
written in Go, `npm run format` if the project is written for NodeJS.
1. Ensure that each commit has a descriptive prefix. This ensures a uniform
commit history and helps structure the changelog.
commit history and helps structure the changelog.
Please refer to this
[list of prefixes for Hydra](https://github.com/ory/hydra/blob/master/.github/semantic.yml)
for an overview.
1. Sign-up with CircleCI so that it has access to your repository with the
branch containing your PR. Simply creating a CircleCI account is sufficient
for the CI jobs to run, you do not need to setup a CircleCI project for the
for the CI jobs to run, you do not need to set up a CircleCI project for the
branch.

If a pull request is not ready to be reviewed yet
Expand Down Expand Up @@ -242,7 +242,7 @@ Now go to the project's GitHub Pull Request page and click "New pull request"
## Conduct

Whether you are a regular contributor or a newcomer, we care about making this
community a safe place for you and we've got your back.
community a safe place for you, and we've got your back.

- We are committed to providing a friendly, safe and welcoming environment for
all, regardless of gender, sexual orientation, disability, ethnicity,
Expand All @@ -257,7 +257,7 @@ community a safe place for you and we've got your back.
you have been or are being harassed or made uncomfortable by a community
member, please contact one of the channel ops or a member of the Ory Hydra
core team immediately.
- Likewise any spamming, trolling, flaming, baiting or other attention-stealing
- Likewise, any spamming, trolling, flaming, baiting or other attention-stealing
behaviour is not welcome.

We welcome discussion about creating a welcoming, safe, and productive
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ that your company deserves a spot here, reach out to
<td>DataDetect</td>
<td align="center"><img height="32px" src="https://raw.githubusercontent.com/ory/meta/master/static/adopters/datadetect.svg" alt="Datadetect"></td>
<td><a href="https://unifiedglobalarchiving.com/data-detect/">unifiedglobalarchiving.com/data-detect/</a></td>
</tr>
</tr>
<tr>
<td>Adopter *</td>
<td>Sainsbury's</td>
Expand All @@ -189,13 +189,13 @@ that your company deserves a spot here, reach out to
<td>Reyah</td>
<td align="center"><img height="32px" src="https://raw.githubusercontent.com/ory/meta/master/static/adopters/reyah.svg" alt="Reyah"></td>
<td><a href="https://reyah.eu/">reyah.eu</a></td>
</tr>
</tr>
<tr>
<td>Adopter *</td>
<td>Zero</td>
<td align="center"><img height="32px" src="https://raw.githubusercontent.com/ory/meta/master/static/adopters/commitzero.svg" alt="Project Zero by Commit"></td>
<td><a href="https://getzero.dev/">getzero.dev</a></td>
</tr>
</tr>
<tr>
<td>Adopter *</td>
<td>Padis</td>
Expand All @@ -213,7 +213,7 @@ that your company deserves a spot here, reach out to
<td>Spiri.bo</td>
<td align="center"><img height="32px" src="https://raw.githubusercontent.com/ory/meta/master/static/adopters/spiribo.svg" alt="Spiri.bo"></td>
<td><a href="https://spiri.bo/">spiri.bo</a></td>
</tr>
</tr>
<tr>
<td>Sponsor</td>
<td>Strivacity</td>
Expand Down Expand Up @@ -284,7 +284,7 @@ and the OpenID Foundation:
ORY Hydra is an OpenID Foundation [certified OpenID Provider (OP)](http://openid.net/certification/#OPs).

<p align="center">
<img src="docs/static/img/docs/oidc-cert.png" alt="ORY Hydra is a certified OpenID Providier" width="256px">
<img src="docs/static/img/docs/oidc-cert.png" alt="ORY Hydra is a certified OpenID Provider" width="256px">
</p>

The following OpenID profiles are certified:
Expand Down Expand Up @@ -457,9 +457,9 @@ There are three types of tests you can run:

- Short tests (do not require a SQL database like PostgreSQL)
- Regular tests (do require PostgreSQL, MySQL, CockroachDB)
- End to end tests (do require databases and will use a test browser)
- End-to-end tests (do require databases and will use a test browser)

All of the above tests can be run using the makefile. See the commands below.
All the above tests can be run using the makefile. See the commands below.

**Makefile commands**

Expand All @@ -485,7 +485,7 @@ It is recommended to use the make file to run your tests using `make quicktest`
All tests run against a sqlite in-memory database,
thus it is required to use the `-tags sqlite` build tag.

Short tests run fairly quickly. You can either test all of the code at once:
Short tests run fairly quickly. You can either test all the code at once:

```shell script
go test -v -failfast -short -tags sqlite ./...
Expand All @@ -507,7 +507,7 @@ go test -v -failfast -short -tags sqlite -run ^TestName$ ./...

Regular tests require a database set up. Our test suite is able to work with docker directly (using [ory/dockertest](https://github.com/ory/dockertest))
but we encourage to use the Makefile instead. Using dockertest can bloat the number of Docker Images on your system
and are quite slow. Instead we recommend doing:
and are quite slow. Instead, we recommend doing:

```shell script
make test
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/before-oauth2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ mobile app. And that's great, because the browser takes care of:

- Bound to one top-level-domain only;
- Anti-XSS with `httpOnly`
- TLS enforcment with `secure`;
- TLS enforcement with `secure`;
- Smaller CSRF attack surface with the new `SameSite` directive;
- The domain model (cookies are isolated per domain);

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ a few things you can do to help out:

- **Give us a star.** It may not seem like much, but it really makes a
difference. This is something that everyone can do to help out Ory Hydra.
Github stars help the project gain visibility and stand out.
GitHub stars help the project gain visibility and stand out.

- **Join the community.** Sometimes helping people can be as easy as listening
to their problems and offering a different perspective. Join our Slack, have a
Expand Down Expand Up @@ -150,13 +150,13 @@ request, go through this checklist:
1. Run `make format` if a `Makefile` is available, `gofmt -s` if the project is
written in Go, `npm run format` if the project is written for NodeJS.
1. Ensure that each commit has a descriptive prefix. This ensures a uniform
commit history and helps structure the changelog.
commit history and helps structure the changelog.
Please refer to this
[list of prefixes for Hydra](https://github.com/ory/hydra/blob/master/.github/semantic.yml)
for an overview.
1. Sign-up with CircleCI so that it has access to your repository with the
branch containing your PR. Simply creating a CircleCI account is sufficient
for the CI jobs to run, you do not need to setup a CircleCI project for the
for the CI jobs to run, you do not need to set up a CircleCI project for the
branch.

If a pull request is not ready to be reviewed yet
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Since ORY Hydra 0.8.0, migrations are no longer run automatically on boot. This
is required in production environments, because:

1. Although SQL migrations are tested, migrating schemas can cause data loss and
should only be done consciously with prior back ups.
should only be done consciously with prior back-ups.
2. Running a production system with a user that has right such as ALTER TABLE is
a security anti-pattern.

Expand Down Expand Up @@ -273,7 +273,7 @@ Check the logs using `docker logs <container-id>`.
## Hydra won't remember my login

Hydra only keeps track of the session if you set the `remember_me` parameter in
the `accept login request`. Otherwise the login challenge will always instruct
the `accept login request`. Otherwise, the login challenge will always instruct
you to show the login UI.

## Where can I get documentation on running multiple instances of Hydra?
Expand All @@ -299,7 +299,7 @@ also some information on collecting statistics in the section on
Yes - you can configure that in your client. It has things like grant_types
etc - there you can basically whitelist the flows you need.

## How can i test if my 4445 is running properly?
## How can I test if my 4445 is running properly?

> I am using ory hydra for authentication. I get a 404 when im trying to create
> a client on my private EC2 hydra task. Is there a way to test if my 4445 is
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ repositories:
- [Go](https://github.com/ory/hydra-client-go)
- [Java](https://search.maven.org/artifact/sh.ory.hydra/hydra-client)
- [JavaScript](https://www.npmjs.com/package/@ory/hydra-client) with TypeScript
definitions and compatible with: NodeJS, ReactJS, AnuglarJS, Vue.js, and many
definitions and compatible with: NodeJS, ReactJS, AngularJS, Vue.js, and many
more.
- [PHP](https://packagist.org/packages/ory/hydra-client)
- [Python](https://pypi.org/project/ory-hydra-client/)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/security-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ at rest, this is might only impose a problem if

### RS256

RSASSA-PKCS1-v1_5 using SHA-256 (RS256) is used to sign JWTs. It’s use is
RSASSA-PKCS1-v1_5 using SHA-256 (RS256) is used to sign JWTs. Its use is
recommended by the JWA specification, see
[https://www.rfc-editor.org/rfc/rfc7518.txt](https://www.rfc-editor.org/rfc/rfc7518.txt)

Expand Down

0 comments on commit 282c269

Please sign in to comment.