Skip to content

Commit d02361c

Browse files
grvsachdevashahidhk
authored andcommitted
fix typos, punctuation, etc in docs (hasura#635)
1 parent 596bccd commit d02361c

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ consisting of 3 components. Each have their own contributing guides:
2222
3. [Console (JavaScript)](console/README.md#contributing-to-hasura-console)
2323

2424
All of the three components have a single version, denoted by either the git
25-
tag, or a combination of branch name and git commit SHA.
25+
tag or a combination of branch name and git commit SHA.
2626

2727
For all contributions, a CLA (Contributor License Agreement) needs to be signed [here](https://cla-assistant.io/hasura/graphql-engine) before (or after) the pull request has been submitted. A bot will prompt the same as a pull request comment.
2828

@@ -65,11 +65,11 @@ before-mentioned sections).
6565
#<issue-no>` in the commit message, at the end.
6666
For example: `resolve answers to everything (fix #42)` or `resolve answers to everything, fix #42`
6767

68-
- Rebase master with your branch before submitting pull request.
68+
- Rebase master with your branch before submitting a pull request.
6969

7070
## Commit messages
7171

72-
- The first line should be a summary of the changes - not execeeding 50
72+
- The first line should be a summary of the changes - not exceeding 50
7373
characters. Followed by an optional body which has more details about the
7474
changes. (https://github.com/erlang/otp/wiki/writing-good-commit-messages)
7575

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ processing - [read more](event-triggers.md).
111111

112112
## Demos
113113

114-
Checkout all the example applications in the
114+
Check out all the example applications in the
115115
[community/examples](community/examples) directory.
116116

117117
### Realtime applications

cli/docs/hasura_console.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ hasura console [flags]
4444

4545
* [hasura](hasura.md) - Hasura GraphQL Engine command line tool
4646

47-
###### Auto generated by spf13/cobra on 28-Sep-2018
47+
###### Auto generated by spf13/cobra on 28-Sep-2018

console/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ cd console
3434
npm install
3535
```
3636

37-
Hasura console can be developed in two modes (`server` or `cli` mode). Both modes requires a running instance of GraphQL Enigne. The easiest way to get Hasura GraphQL engine instance is by Heroku. You can get it by following the steps given in [this](https://docs.hasura.io/1.0/graphql/manual/getting-started/heroku-simple.html) link. Other methods to install Hasura GraphQL engine is documented [here](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
37+
Hasura console can be developed in two modes (`server` or `cli` mode). Both modes require a running instance of GraphQL Enigne. The easiest way to get Hasura GraphQL engine instance is by Heroku. You can get it by following the steps given in [this](https://docs.hasura.io/1.0/graphql/manual/getting-started/heroku-simple.html) link. Other methods to install Hasura GraphQL engine is documented [here](https://docs.hasura.io/1.0/graphql/manual/getting-started/index.html).
3838

3939
### Development with Hasura GraphQL Engine (`server` mode)
4040

41-
Hasura GraphQL engine should be running to develop console in this mode. If you have set it up on heroku, your url will look like `<app-name>.herokuapp.com`, if it's on you local machine, it's probably `http://localhost:8080`.
41+
Hasura GraphQL engine should be running to develop console in this mode. If you have set it up on heroku, your url will look like `<app-name>.herokuapp.com`, if it's on your local machine, it's probably `http://localhost:8080`.
4242

4343
[Dotenv](https://github.com/motdotla/dotenv) is used for setting environment variables for development. Create a `.env` file in the root directory for console (wherever package.json is). Sample `.env` file will look like below
4444

@@ -119,7 +119,7 @@ Visit [http://localhost:3000](http://localhost:3000) to confirm the setup.
119119

120120
![Testing Development Server](../assets/console-readme-assets/test-dev-setup.jpg)
121121

122-
### Make changes to code
122+
### Make changes to the code
123123

124124
Make changes to the code and the console will reload automatically to reflect the new changes. Keep iterating.
125125
When adding a new feature, it is recommended to add corresponding tests too.

event-triggers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Transform and load data into external data-stores. Check out this demo and tutor
9393

9494
### Building reactive UX for your async backend with realtime GraphQL
9595

96-
Propagate event driven and asynchronous information to UI clients easily with GraphQL subscriptions & live-queries.
96+
Propagate event-driven and asynchronous information to UI clients easily with GraphQL subscriptions & live-queries.
9797

9898
![Reactive apps architecture](assets/reactive-apps-arch.png)
9999

server/CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ own machine, and how to contribute.
66
## Pre-requisites
77

88
- [stack](https://docs.haskellstack.org/en/stable/README/#how-to-install)
9-
- A postgres server (Recommended: Use docker to run a local postgres instance)
9+
- A Postgres server (Recommended: Use docker to run a local postgres instance)
1010
- GNU Make (optional)
1111

1212
## Development workflow
@@ -26,7 +26,7 @@ own machine, and how to contribute.
2626

2727
### Work
2828
- Work on the feature/fix
29-
- Add testcases if relevant
29+
- Add test cases if relevant
3030

3131
### Test
3232
- Run tests: `stack test --ta --database-url=<database-url>`

0 commit comments

Comments
 (0)