fix: Grammatical correction in readme file #2798

idivyanshbansal · 2021-10-13T18:01:07Z

#2797

Related issue(s)

Checklist

I have read the contributing guidelines.
I am following the
contributing code guidelines.
I have read the security policy.
I confirm that this pull request does not address a security
vulnerability. If this pull request addresses a security. vulnerability, I
confirm that I got green light (please contact
security@ory.sh) from the maintainers to push
the changes.
I have added tests that prove my fix is effective or that my feature
works.
I have added or changed the documentation.

Further Comments

codecov · 2021-10-13T18:22:30Z

Codecov Report

Merging #2798 (abfc41e) into master (433ce74) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2798   +/-   ##
=======================================
  Coverage   52.85%   52.85%           
=======================================
  Files         236      236           
  Lines       14184    14184           
=======================================
  Hits         7497     7497           
  Misses       6054     6054           
  Partials      633      633

Impacted Files	Coverage Δ
internal/httpclient/models/volume.go	`0.00% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8373bba...abfc41e. Read the comment docs.

vinckr

Thanks for the contribution 🙂
I have left some comments, and parts of the README are automated from a template.
If you are up to it, open another PR in /meta and it will be fixed for all Ory projects 🎉

vinckr · 2021-10-13T18:14:00Z

README.md

@@ -35,7 +35,7 @@ If you're looking to jump straight into it, go ahead:
 - [Install and Set Up ORY Hydra](https://www.ory.sh/docs/hydra/configure-deploy): An advanced look at installation options and interaction with ORY Hydra.
 - [Integrating your Login and Consent UI with ORY Hydra](https://www.ory.sh/docs/hydra/oauth2): The go-to place if you wish to adopt ORY Hydra in your new or existing stack.

-Besides mitigating various attack vectors, such as database compromisation and OAuth 2.0 weaknesses, ORY Hydra is also
+Besides mitigating various attack vectors, such as database compromise and OAuth 2.0 weaknesses, ORY Hydra is also


Suggested change

Besides mitigating various attack vectors, such as database compromise and OAuth 2.0 weaknesses, ORY Hydra is also

Besides mitigating various attack vectors, such as a compromised database and OAuth 2.0 weaknesses, ORY Hydra is also

I think compromisation was actually correct.

Noun. compromisation (countable and uncountable, plural compromisations) The act or result of compromising.

Compromise also has a different meaning as noun:

an agreement or settlement of a dispute that is reached by each side making concessions.
"eventually they reached a compromise"

Compromisation is not a beautiful word though, what do you think of this suggestion

vinckr · 2021-10-13T18:14:43Z

README.md

@@ -78,7 +78,7 @@ able to securely manage JSON Web Keys.
 - [Libraries and third-party projects](#libraries-and-third-party-projects)
 - [Blog posts & articles](#blog-posts--articles)

-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- END doctoc generated TOC please keep comment here to allow auto-update -->


Suggested change





Please revert this as it needs to stay the same :)

vinckr · 2021-10-13T18:18:23Z

README.md

@@ -312,7 +312,7 @@ To obtain certification, we deployed the [reference user login and consent app](

 ## Quickstart

-This section is a quickstart guide to working with ORY Hydra. In-depth docs are available as well:
+This section is a quick start guide to working with ORY Hydra. In-depth docs are available as well:


Suggested change

This section is a quick start guide to working with ORY Hydra. In-depth docs are available as well:

This section is a starter guide to working with ORY Hydra. In-depth docs are available as well:

I think this sounds more natural.

"quickstart guide" is the correct terminology here: https://en.wikipedia.org/wiki/Quickstart_guide

vinckr · 2021-10-13T18:20:57Z

README.md

@@ -343,7 +343,7 @@ design:
 - Scales without effort
 - Minimize room for human and network errors

-Ory's architecture designed to run best on a Container Orchestration Systems
+Ory's architecture is designed to run best on a Container Orchestration Systems


This ECOSYSTEM part has to be edited in ory/meta, specifically in this file:
https://github.com/ory/meta/blob/master/templates/repository/common/PROJECTS.md if you are up to making another PR there.

Otherwise please revert it in this PR as it will be overwritten later.

vinckr · 2021-10-13T18:22:39Z

README.md

@@ -352,17 +352,17 @@ dependencies (Java, Node, Ruby, libxml, ...).
 ### Ory Kratos: Identity and User Infrastructure and Management

 [Ory Kratos](https://github.com/ory/kratos) is an API-first Identity and User
-Management system that is built according to
+A management system that is built according to


See comment above about the ECOSYSTEM part.

vinckr · 2021-10-13T18:22:43Z

README.md

 [cloud architecture best practices](https://www.ory.sh/docs/next/ecosystem/software-architecture-philosophy).
 It implements core use cases that almost every software application needs to
 deal with: Self-service Login and Registration, Multi-Factor Authentication
-(MFA/2FA), Account Recovery and Verification, Profile and Account Management.
+(MFA/2FA), Account Recovery and Verification, Profile, and Account Management.


See comment above about the ECOSYSTEM part.

vinckr · 2021-10-13T18:22:47Z

README.md


 ### Ory Hydra: OAuth2 & OpenID Connect Server

 [Ory Hydra](https://github.com/ory/hydra) is an OpenID Certified™ OAuth2 and
 OpenID Connect Provider which easily connects to any existing identity system by
-writing a tiny "bridge" application. Gives absolute control over user interface
+writing a tiny "bridge" application. Gives absolute control over the user interface


See comment above about the ECOSYSTEM part.

idivyanshbansal · 2021-10-13T18:38:29Z

@vinckr sir I have done the updates of this file. Else I am making PR in meta/projects

idivyanshbansal · 2021-10-13T18:43:08Z

@vinckr Sir, done all the updates in both files.

grantzvolsky · 2021-10-13T19:22:45Z

README.md

@@ -329,7 +329,7 @@ It will take you about 5 minutes to complete the **[tutorial](https://www.ory.sh

 ### Installation

-Head over to the [ORY Developer Documentation](https://www.ory.sh/docs/next/hydra/configure-deploy#installing-ory-hydra) to learn how to install ORY Hydra on Linux, macOS, Windows, and Docker and how to build ORY Hydra from source.
+Head over to the [ORY Developer Documentation](https://www.ory.sh/docs/next/hydra/configure-deploy#installing-ory-hydra) to learn how to install ORY Hydra on Linux, macOS, Windows, and Docker and how to build ORY Hydra from the source.


to build ORY Hydra from source. is the correct alternative.

idivyanshbansal · 2021-10-14T01:59:07Z

@grantzvolsky sir, @aeneasr sir, @vinckr sir, done

vinckr · 2021-10-22T08:06:56Z

Hello @idivyanshbansal ,
there are still several issues to be resolved, please see my review.

idivyanshbansal · 2021-10-22T09:43:55Z

Hello @idivyanshbansal , there are still several issues to be resolved, please see my review.

Those else issues were resolved in the extension repository of hydra @vinckr, sir.

vinckr · 2021-10-22T10:39:56Z

No need to call me sir @idivyanshbansal 😉.
I can see that you made another PR in /meta, thanks for that!
Could you still revert the changes that would be overwritten by the template in /meta please?

Basically all changes you made after the :

🙏

idivyanshbansal · 2021-10-24T10:26:26Z

Thankyou @aeneasr sir 🤩

Update README.md

151fd57

idivyanshbansal requested a review from aeneasr as a code owner October 13, 2021 18:01

vinckr requested changes Oct 13, 2021

View reviewed changes

Update README.md

0f3a8f4

idivyanshbansal mentioned this pull request Oct 13, 2021

fix: grammatical error of documentation ory/meta#121

Merged

grantzvolsky reviewed Oct 13, 2021

View reviewed changes

Update README.md

abfc41e

vinckr mentioned this pull request Oct 19, 2021

Debugging grammatical error in readme file #2810

Closed

6 tasks

aeneasr approved these changes Oct 23, 2021

View reviewed changes

aeneasr merged commit 0274fcc into ory:master Oct 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Grammatical correction in readme file #2798

fix: Grammatical correction in readme file #2798

idivyanshbansal commented Oct 13, 2021 •

edited

codecov bot commented Oct 13, 2021 •

edited

vinckr left a comment

vinckr Oct 13, 2021

vinckr Oct 13, 2021

vinckr Oct 13, 2021

aeneasr Oct 13, 2021

vinckr Oct 13, 2021

vinckr Oct 13, 2021

vinckr Oct 13, 2021

vinckr Oct 13, 2021

idivyanshbansal commented Oct 13, 2021

idivyanshbansal commented Oct 13, 2021

grantzvolsky Oct 13, 2021

idivyanshbansal commented Oct 14, 2021

vinckr commented Oct 22, 2021

idivyanshbansal commented Oct 22, 2021

vinckr commented Oct 22, 2021

idivyanshbansal commented Oct 24, 2021

	Besides mitigating various attack vectors, such as database compromise and OAuth 2.0 weaknesses, ORY Hydra is also
	Besides mitigating various attack vectors, such as a compromised database and OAuth 2.0 weaknesses, ORY Hydra is also

	<!-- END doctoc generated TOC please keep comment here to allow auto-update -->
	<!-- END doctoc generated TOC please keep comment here to allow auto update -->

	This section is a quick start guide to working with ORY Hydra. In-depth docs are available as well:
	This section is a starter guide to working with ORY Hydra. In-depth docs are available as well:

fix: Grammatical correction in readme file #2798

fix: Grammatical correction in readme file #2798

Conversation

idivyanshbansal commented Oct 13, 2021 • edited

Related issue(s)

Checklist

Further Comments

codecov bot commented Oct 13, 2021 • edited

Codecov Report

vinckr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

idivyanshbansal commented Oct 13, 2021

idivyanshbansal commented Oct 13, 2021

Choose a reason for hiding this comment

idivyanshbansal commented Oct 14, 2021

vinckr commented Oct 22, 2021

idivyanshbansal commented Oct 22, 2021

vinckr commented Oct 22, 2021

idivyanshbansal commented Oct 24, 2021

idivyanshbansal commented Oct 13, 2021 •

edited

codecov bot commented Oct 13, 2021 •

edited