Skip to content

Commit db12be0

Browse files
fixed typo in developer-docs
1 parent f373938 commit db12be0

File tree

10 files changed

+54230
-418
lines changed

10 files changed

+54230
-418
lines changed

developer_docs/accessibility.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## Accessibility Guidelines
22

3-
Here is guide on [how to use the accessible editor](https://gist.github.com/MathuraMG/e86666b7b41fbc8c078bad9aff3f666d) and here is an overview of the [p5-accessibility.js](https://github.com/processing/p5.accessibility) library that makes p5.js sketches accessible to screen readers.
3+
Here is a guide on [how to use the accessible editor](https://gist.github.com/MathuraMG/e86666b7b41fbc8c078bad9aff3f666d) and here is an overview of the [p5-accessibility.js](https://github.com/processing/p5.accessibility) library that makes p5.js sketches accessible to screen readers.
44

55
The code for the p5.js web editor adheres to web accessibility standards. The following guidelines will help to ensure that accessibility continues to be a priority as development continues.
66

77
**Code Structure**
88

9-
* Screen Readers are an assistive technology for vision loss which helps users to navigate a web page. They are able to prioritize content based on the semantic meaning of HTML tags. Therefore, it is important to use specific tags, such as `nav`, `ul`, `li`, `section`, and so on. `div` is the least screen reader friendly tag. For example, [here is the semantic meaning of the `body` tag](http://html5doctor.com/element-index/#body)
9+
* Screen Readers are an assistive technology for vision loss that helps users to navigate a web page. They are able to prioritize content based on the semantic meaning of HTML tags. Therefore, it is important to use specific tags, such as `nav`, `ul`, `li`, `section`, and so on. `div` is the least screen reader-friendly tag. For example, [here is the semantic meaning of the `body` tag](http://html5doctor.com/element-index/#body)
1010
* All buttons/links/windows need to be accessible by the keyboard ( By tabbing, pressing space etc.)
11-
* In cases where tags are not screen reader friendly, we can take advantage of [tabIndex](http://webaim.org/techniques/keyboard/tabindex). Using tabIndex ensures that all elements are accessible via keyboard. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/Editor.jsx#L249)
11+
* In cases where tags are not screen reader-friendly, we can take advantage of [tabIndex](http://webaim.org/techniques/keyboard/tabindex). Using tabIndex ensures that all elements are accessible via keyboard. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/Editor.jsx#L249)
1212
* When opening a new window or pop up window, ensure the keyboard focus also moves to the new window. [code example](https://github.com/processing/p5.js-web-editor/blob/develop/client/modules/IDE/components/NewFileForm.jsx#L16)
1313

1414
**Labeling**

developer_docs/deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ WIP.
1717

1818
These are the steps that happen when you deploy the application.
1919

20-
1. Push to `develop` branch, or merge in a pull request to the `develop` branch.
20+
1. Push to the `develop` branch, or merge in a pull request to the `develop` branch.
2121
2. This triggers a build on [Travis CI](https://travis-ci.org/processing/p5.js-web-editor).
2222
3. Travis CI builds a (development) Docker image of the whole application.
2323
4. Travis CI runs some tests, which in this case, is just `npm run lint`. This could be updated in the future to include more extensive tests. If the tests fail, the build stops here.
@@ -47,7 +47,7 @@ If you are interested in hosting and deploying your own p5.js Web Editor instanc
4747

4848
1. Sign up for a free account at: [Heroku](https://www.heroku.com/)
4949
2. Click here: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/processing/p5.js-web-editor/tree/develop)
50-
3. Enter a unique *App name*, this will become part of the url (i.e. https://app-name.herokuapp.com/)
50+
3. Enter a unique *App name*, this will become part of the URL (i.e. https://app-name.herokuapp.com/)
5151
4. Update any configuration variables, or accept the defaults for a quick evaluation (they can be changed later to enable full functionality)
5252
5. Click on the "Deploy app" button
5353
6. When complete, click on the "View app" button

developer_docs/development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Follow the [installation guide](./installation.md).
2222
As a person contributing code but not creating production releases (this is most people!), here's what you need to know:
2323
* The default branch is `develop`. All pull requests should be made to this branch. It should be stable, and all commits are visible at a staging server.
2424
* When working on a bug or feature, you should branch from the `develop` branch. When you're done, you should open a pull request from your feature branch to `develop`.
25-
* The `release` branch is the live production branch, and is the code deployed to editor.p5js.org. Changes to this branch should be made carefully, and will be done using git tags.
25+
* The `release` branch is the live production branch and is the code deployed to editor.p5js.org. Changes to this branch should be made carefully and will be done using git tags.
2626
* Emergency hotfix changes should be branched from `release` and merged via a pull request to `release`. After a PR is merged, then the commits can be merged to `develop`.
2727

2828
See the [release guide](./release.md) for information about creating a release.
@@ -68,7 +68,7 @@ Structure your commit message like this:
6868
* Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed".
6969
* Link the GitHub issue you are working on in the summary line in brackets, e.g. [#123]
7070
* Always leave the second line blank.
71-
* Be as descriptive as possible in the description. It helps reasoning about the intention of commits and gives more context about why changes happened.
71+
* Be as descriptive as possible in the description. It helps to reason about the intention of commits and gives more context about why changes happened.
7272
* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`.
7373
* Note that you can connect multiple issues to a commit, if necessary: `[#123][#456] Add Button component`
7474

@@ -87,7 +87,7 @@ Structure your commit message like this:
8787

8888
- For common and reusable styles, write OOSCSS (Object-Oriented SCSS) with placeholders and mixins. For organizing styles, follow the [7-1 Pattern](https://sass-guidelin.es/#the-7-1-pattern) for Sass.
8989

90-
- We're using [ES6](http://es6-features.org/) and transpiling to ES5 using [Babel](https://babeljs.io/).
90+
- We're using [ES6](http://es6-features.org/) and transpile to ES5 using [Babel](https://babeljs.io/).
9191

9292
- For reference to the JavaScript style guide, see the [Airbnb Style Guide](https://github.com/airbnb/javascript), [React ESLint Plugin](https://github.com/yannickcr/eslint-plugin-react).
9393

developer_docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ _Note_: The installation steps assume you are using a Unix-like shell. If you ar
2525
* For Mac OSX with [homebrew](http://brew.sh/): `brew tap mongodb/brew` then `brew install mongodb-community` and finally start the server with `brew services start mongodb-community` or you can visit the installation guide here [Installation Guide For MacOS](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/)
2626
* For Windows and Linux: [MongoDB Installation](https://docs.mongodb.com/manual/installation/)
2727
7. `$ cp .env.example .env`
28-
8. (Optional) Update `.env` with necessary keys to enable certain app behaviors, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
28+
8. (Optional) Update `.env` with necessary keys to enable certain app behaviours, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
2929
9. Run `$ npm run fetch-examples` to download the example sketches into a user called 'p5'. Note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
3030
10. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
3131
11. `$ npm start`
@@ -47,7 +47,7 @@ Note that this takes up a significant amount of space on your machine. Make sure
4747
2. Clone this repository and cd into it
4848
3. `$ docker-compose -f docker-compose-development.yml build`
4949
4. `$ cp .env.example .env`
50-
5. (Optional) Update `.env` with necessary keys to enable certain app behavoirs, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
50+
5. (Optional) Update `.env` with necessary keys to enable certain app behaviours, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
5151
6. `$ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples` - note that you need to configure your GitHub Credentials, which you can do by following the [Github API Configuration](#github-api-configuration) section.
5252
7. Enable Prettier in your text editor by following [this guide](https://prettier.io/docs/en/editors.html).
5353

@@ -66,12 +66,12 @@ If you don't have the full server environment running, you can launch a one-off
6666

6767
## S3 Bucket Configuration
6868

69-
Note that this is optional, unless you are working on the part of the application that allows a user to upload images, videos, etc. Please refer to the following [gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) to set up an S3 bucket to be used with this project.
69+
Note that this is optional unless you are working on the part of the application that allows a user to upload images, videos, etc. Please refer to the following [gist](https://gist.github.com/catarak/70c9301f0fd1ac2d6b58de03f61997e3) to set up an S3 bucket to be used with this project.
7070

7171
If your S3 bucket is in the US East (N Virginia) region (us-east-1), you'll
7272
need to set a custom URL base for it, because it does not follow the standard
7373
naming pattern as the rest of the regions. Instead, add the following to your
74-
environment/.env file, changing `BUCKET_NAME` to your bucket name. This is necessary because this override is currently treated as the full path to the bucket rather than as a proper base url:
74+
environment/.env file, changing `BUCKET_NAME` to your bucket name. This is necessary because this override is currently treated as the full path to the bucket rather than as a proper base URL:
7575
`S3_BUCKET_URL_BASE=https://s3.amazonaws.com/{BUCKET_NAME}/`
7676

7777
If you've configured your S3 bucket and DNS records to use a custom domain

developer_docs/preparing_a_pull_request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Pull-requests are easier when your code is up to date! You can use git rebase to
1313

1414

1515
### Find out about changes
16-
Make sure you're tracking upstream p5.js repository.
16+
Make sure you're tracking the upstream p5.js repository.
1717

1818
git remote show upstream
1919

@@ -43,7 +43,7 @@ Then ask git about the latest changes.
4343
## CONFLICTS
4444
You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream `develop` branch causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
4545

46-
## And finally, for great glory
46+
## And finally, for the great glory
4747
git push --set-upstream origin your-branch-name-backup
4848

4949
Here's a good reference on rebasing, in case you're intensely curious about the technical details. https://www.atlassian.com/git/tutorials/merging-vs-rebasing

developer_docs/public_api.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This API provides a way to programmatically import data into the p5.js Web Edito
44

55
# Authentication
66

7-
Access to the API is available via a Personal Access Token, linked to an existing editor user account. Tokens can be created and deleted via logged-in user’s Settings page.
7+
Access to the API is available via a Personal Access Token, linked to an existing editor user account. Tokens can be created and deleted via the logged-in user’s Settings page.
88

99
When contacting the API, the username and token must be sent with every request using basic auth.
1010

@@ -116,7 +116,7 @@ List a user’s sketches.
116116
This will not return the files within the sketch, just the sketch metadata.
117117

118118
### Request format
119-
No body.
119+
Nobody.
120120

121121
### Response format
122122
{
@@ -139,7 +139,7 @@ No body.
139139

140140
Create a new sketch.
141141

142-
A sketch must contain at least one file with the `.html` extension. If none if provided in the payload, a default `index.html` and linked `style.css` file will be created automatically.
142+
A sketch must contain at least one file with the `.html` extension. If none is provided in the payload, a default `index.html` and linked `style.css` file will be created automatically.
143143

144144
### Request format
145145
See `Sketch` in Models above.
@@ -199,13 +199,13 @@ See `Sketch` in Models above.
199199

200200
## `DELETE /:user/sketches/:id`
201201

202-
Delete a sketch and all it’s associated files.
202+
Delete a sketch and all its associated files.
203203

204204
### Request format
205-
No body
205+
Nobody
206206

207207
### Response format
208-
No body
208+
Nobody
209209

210210
### Example
211211

developer_docs/public_api_proposed.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Proposed Public API extensions
22

3-
This describes proposed extensions to the Public API. None of these extensions are confirmed, but are recorded here for reference and discussion.
3+
This describes proposed extensions to the Public API. None of these extensions is confirmed but is recorded here for reference and discussion.
44

55
Refer to [Public API](./public_api.md) for the current version of the API.
66

77
# Authentication
88

9-
- Support for sending tokens can via the `Authorization: Bearer {your_access_token}` HTTP header instead of just Basic Auth
9+
- Support for sending tokens can be via the `Authorization: Bearer {your_access_token}` HTTP header instead of just Basic Auth
1010

1111
# API Access
1212

@@ -22,7 +22,7 @@ Refer to [Public API](./public_api.md) for the current version of the API.
2222
Fetch a sketch.
2323

2424
### Request format
25-
No body.
25+
Nobody.
2626

2727
### Response format
2828
Returns `Sketch`.
@@ -56,7 +56,7 @@ Replace the sketch with an entirely new one, maintaining the same ID. Any existi
5656
See `Sketch` in Models above.
5757

5858
### Response format
59-
No body.
59+
Nobody.
6060

6161
### Example
6262

@@ -90,7 +90,7 @@ Update the sketch whilst maintaining existing data:
9090
See `Sketch` in Models above.
9191

9292
### Response format
93-
No body.
93+
Nobody.
9494

9595
### Example
9696
Change the name of the sketch
@@ -131,7 +131,7 @@ Files within a sketch can be individually accessed via their `path` e.g. `data/s
131131
Fetch the contents of a file.
132132

133133
### Request format
134-
No body.
134+
Nobody.
135135

136136
### Response format
137137
Returns file contents.
@@ -154,15 +154,15 @@ Returns file contents.
154154

155155
## `PATCH /:user/sketches/:id/files/:path`
156156

157-
Update the name or contents a file or directory.
157+
Update the name or contents of a file or directory.
158158

159159
### Request format
160160
See `File` and `Directory` above.
161161

162162
### Response format
163-
No body.
163+
Nobody.
164164

165-
### Example: Change file name
165+
### Example: Change the file name
166166

167167
PATCH /p5/sketches/Ckhf0APpg/files/assets/something.js
168168

@@ -206,13 +206,13 @@ Files are added to the directory, in addition to what is there.
206206

207207
## `DELETE /:user/:sketches/files/:path`
208208

209-
Delete a file/directory, and it’s contents.
209+
Delete a file/directory, and its contents.
210210

211211
### Request format
212-
No body.
212+
Nobody.
213213

214214
### Response format
215-
No body.
215+
Nobody.
216216

217217
### Example: Delete file
218218

0 commit comments

Comments
 (0)