Skip to content

Commit 9327f71

Browse files
authored
chore: multiple grammar or wording fixes (#162)
1 parent 8a4c683 commit 9327f71

16 files changed

+59
-59
lines changed

docs/development/accessibility.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Developers may also use pre-made components with accessibility features built in
5959

6060
Users should make sure to read and understand the accessibility documentation for pre-made components.
6161
It is also best practice to incorporate testing of your application with common
62-
assisitive technologies like screen readers and limiting input to keyboard interaction. See [tooling](#tooling) below.
62+
assistive technologies like screen readers and limiting input to keyboard interaction. See [tooling](#tooling) below.
6363

6464
For those working on Linux
6565
[List Of Accessibility Documentation Sources And Tools (For GNU/Linux Development And Testing)](https://desktopqe-jenkins.rhev-ci-vms.eng.rdu2.redhat.com:3200/desktopqe/d06-projects/a11y.A11y_devel_doc_sources.html)
@@ -76,7 +76,7 @@ reference for working with the guidelines. The [WAI-ARIA Authoring Practices Exa
7676

7777
In the teams experience testing/validation of accessibility requirements will be
7878
against the front-end and not the APIs provided by the Node.js back-end. The result
79-
being that team members building the front-end must be knowleadgeable on
79+
being that team members building the front-end must be knowledgeable on
8080
accessibility requirements. Back-end Node.js developers, on the other hand, will support
8181
requirements that come from the front-end versus driving the accessibility effort.
8282

@@ -104,7 +104,7 @@ accessibility testing.
104104
Command line tools have been historically considered more accessible (see
105105
[Accessibility of Command Line Interfaces](https://dl.acm.org/doi/fullHtml/10.1145/3411764.3445544)
106106
for discussion on this topic).
107-
For this reason, most if not all of accessibility standards and guidlines are for
107+
For this reason, most if not all of accessibility standards and guidelines are for
108108
graphical user interfaces. The team is not aware of standards or guidelines that
109109
provide guidance specifically for command line applications.
110110

@@ -128,7 +128,7 @@ include:
128128

129129
Accessibility tooling is generally not Node.js specific. However some tools are
130130
built in Node.js and are delivered through npm. They will, therefore, fit easily in a JavaScript
131-
or Node.js workflow when nessary. For example:
131+
or Node.js workflow when necessary. For example:
132132
* [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)
133133
* [axe-core](https://www.npmjs.com/package/axe-core)
134134
* [pa11y](https://www.npmjs.com/package/pa11y)

docs/development/building-good-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ as not being able use the `NODE_EXTRA_CA_CERTS` environment
6060
variable. You can read more about the issue
6161
[here](https://github.com/nodejs/node/pull/37727).
6262

63-
Typical work arounds which include using firewall functionality to
63+
Typical workarounds which include using firewall functionality to
6464
proxy ports most often don't work in containers as the firewall
6565
capability is often not included in container distributions.
6666

docs/development/ci-cd.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ existing Node.js image (for example)
1818
[ubi8/nodejs-16](https://catalog.redhat.com/software/containers/ubi8/nodejs-16/615aee9fc739c0a4123a87e1)
1919
image or a [dependency image](./building-good-containers.md#dependency-image).
2020

21-
While a Node.js developer may not need to setup the CI/CD pipleline a
21+
While a Node.js developer may not need to setup the CI/CD pipeline a
2222
good understanding of their organizations pipeline is often valuable
2323
in order to understand what's needed to externalize configuration in
2424
the code they write as well as being able to investigate problems that
@@ -30,7 +30,7 @@ N/A
3030

3131
## Guidance
3232

33-
The team's experiece is that there are most often two different ci/cd flows
33+
The team's experience is that there are most often two different ci/cd flows
3434
which are used at the same time:
3535

3636
* Testing on code check-in
@@ -55,7 +55,7 @@ for this kind of testing for Node.js components are captured in the
5555
[Code Consistency](./code-consistency.md),
5656
[Testing](./testing.md), and
5757
[Code Coverage](./code-coverage.md) sections. Teams often
58-
then also test the PR by spinning up a container environment and runing some
58+
then also test the PR by spinning up a container environment and running some
5959
initial integration test. If you run check-in integration tests it is often useful to run both
6060
integration and unit tests in the container in order to capture a more complete picture
6161
of the Code Coverage achieved.
@@ -84,15 +84,15 @@ support a number of stages/environments including:
8484

8585
* Development
8686
* This environment often mirrors the main branch of each component
87-
and may sometimes not be working due to mistmatches in APIs/use of APIs.
87+
and may sometimes not be working due to mismatches in APIs/use of APIs.
8888
* Once tests pass in development, PRs may be automatically opened to
8989
update Staging to the new component levels.
9090
* Staging
9191
* Staging uses tagged versions of each component which are known to
9292
work together.
9393
* They may be multiple staging environments. One which
9494
mirrors production in terms of non-application components
95-
(versions of istio, kubernetes, etc.) and additional
95+
(versions of Istio, Kubernetes, etc.) and additional
9696
environments which reflect future target configurations
9797
for these components.
9898
* PRs may be automatically created to update component versions in
@@ -125,13 +125,13 @@ configuration for how to connect to databases and other services, the
125125
Node.js run configuration (production/development) and any other configuration
126126
information.
127127

128-
[Jekins](https://www.jenkins.io/) and
128+
[Jenkins](https://www.jenkins.io/) and
129129
[Tekton Pipelines](https://tekton.dev/) are common tools that have been
130130
used by the team to implement the container pipeline.
131131

132132
The team has found that it is advisable to use a separate git repository/branch
133133
to configure the versions of the components to be tested in each environment
134-
within the container pipeline. One commmon pattern the team has seen is using
134+
within the container pipeline. One common pattern the team has seen is using
135135
helm charts within this repo to configure the versions of the components used
136136
along with the configuration required for a given environment.
137137

@@ -149,11 +149,11 @@ The benefit of running in the check-in tests helps developers validate that
149149
they have resolved reported issue.
150150
deploys checks in both the check-in tests as well as the container pipeline.
151151

152-
Tools like [mend](https://www.mend.io/), [Synk](https://snyk.io/) and those
152+
Tools like [mend](https://www.mend.io/), [Snyk](https://snyk.io/) and those
153153
built into GitHub have been used for scanning in the check-in phase. Often
154-
a number of differents scans are required to cover all of the important aspects
154+
a number of different scans are required to cover all of the important aspects
155155
which include scans of:
156-
* application depencencies for vulnerabilities
156+
* application dependencies for vulnerabilities
157157
* os packages for vulnerabilities
158158
* source code using static analysis
159159
* container images for best practices (not running as root etc.)

docs/development/code-coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Code coverage should never block a production deployment
5151

5252
## Output Formats
5353

54-
A common output format is the lcov format, which the recommeneded modules can produce.
54+
A common output format is the lcov format, which the recommended modules can produce.
5555

5656
[jest]: https://www.npmjs.com/package/jest
5757
[nyc]: https://www.npmjs.com/package/nyc

docs/development/cross-origin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are two patterns that the team is familiar with when dealing with Cross Or
77

88
## Cross Origin Resource Sharing (CORS)
99

10-
By default, browers assume that your backend server doesn't want to share its resources with a front-end that it doesn't know about.
10+
By default, browsers assume that your backend server doesn't want to share its resources with a front-end that it doesn't know about.
1111

1212
You might have seen this error in the browsers dev console:
1313

@@ -21,7 +21,7 @@ However, there are certain situations where your backend might want to be access
2121

2222
When developing a backend with a public API and you would like to control access to certain resources and how they are used, CORS should be enabled.
2323

24-
**note: When enabling CORS, it is important to limit those methods and headers your application allows to prevent unwanted actors from accessesing resources they shouldn't be accessing.**
24+
**note: When enabling CORS, it is important to limit those methods and headers your application allows to prevent unwanted actors from accessing resources they shouldn't be accessing.**
2525

2626

2727
### Access to Multiple Environments

docs/development/dependencies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ Based on the teams experience we recommend the following:
4343
[Canary in the Gold Mine](https://github.com/nodejs/citgm)?
4444
* If the dependency is a native module does it use Node-API (use
4545
of Node-API means that packages can work across Node.js major versions)
46-
* Only use dependencies with licences acceptable to your organization
46+
* Only use dependencies with licenses acceptable to your organization
4747
* When choosing to use dependencies with a lower level of use in the
4848
ecosystem doing a code review to look for red flags can be useful.
4949

5050
When evaluating dependencies, the teams typically evaluate the top level
5151
dependencies versus the full tree **EXCEPT** for the following in which
5252
we evaluate the full tree:
53-
* Licence Checks
53+
* License Checks
5454
* Security vulnerabilities (CVEs)
5555
Total number of sub-dependencies
5656

docs/development/dev-flows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Typical Development Workflows
22

3-
Developement flows within the team's developer and the customers the team works
4-
with need to accomodate the following:
3+
Development flows within the team's developer and the customers the team works
4+
with need to accommodate the following:
55

66
* the end target/deployment artifact is most often a container
77
* for some platforms, deployment remains a server or virtual machine
@@ -120,7 +120,7 @@ Disadvantages:
120120

121121
## Zero install development environment
122122

123-
Developers use a virtualized remote enviroment and use their local laptop
123+
Developers use a virtualized remote environment and use their local laptop
124124
only as a thin client.
125125

126126
This model is typically an extension to one of the other

docs/development/kubernetes-dev-environment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Kubernetes-based Development Environment Recommendations
22

3-
Developement and local-testing flows should ideally be the same for all the developers of a project, but its
4-
common for developers on a team to have heterogeneus development platforms (i.e. Linux, Intel-based MacOS, M1-based MacOS, Windows).
3+
Development and local-testing flows should ideally be the same for all the developers of a project, but its
4+
common for developers on a team to have heterogenous development platforms (i.e. Linux, Intel-based MacOS, M1-based MacOS, Windows).
55
Using kubernetes as a homogenized execution/configuration layer can be key to ensure testing/deployment
66
use the same configuration settings for all developers. Building a docker image is the same "docker build ..." command
77
regardless of development platform, and kubernetes configuration settings, ideally built through yaml configuration files and
@@ -50,7 +50,7 @@ If possible, avoid using shared databases and use local k8s deployments of the d
5050
developers. As long as you are careful to make sure your development zone does not contain customer data, then making backups of your
5151
development databases and loading those backups in local development copies can help speed up your testcase creation process and
5252
leverage "end to end" tests that may use such data. It's common to use public helm charts (or make a copy of them) to deploy these
53-
databases in your local or CICD environments. Example charts:
53+
databases in your local or CI/CD environments. Example charts:
5454
* Minio to locally replicate S3 APIs and storage: https://github.com/minio/minio/tree/master/helm/minio
5555
* A huge selection of others can be found from Bitnami's collection at https://github.com/bitnami/charts/tree/main/bitnami
5656

@@ -118,13 +118,13 @@ So just like how debugger flags and nodemon can be conditionally turned on in a
118118
integration test run. When doing this, one should run nyc around the execution of the unit + integration tests to capture the code
119119
coverage from the combination of the two types of tests. However, one can't have the pod test-script immediately finish once the test
120120
finishes, or else the test results will disappear when the test pod shuts down. Normally, local developer testing can then just look at
121-
the logs of the shutdown pod to see if it was successful or not, but when debugging failures in a CICD pipeline like Travis/Jenkins, its
121+
the logs of the shutdown pod to see if it was successful or not, but when debugging failures in a CI/CD pipeline like Travis/Jenkins, its
122122
very useful to run the same logic locally on one's development system, and those flows will typically need the full test result files.
123123

124124
There are two general solutions for this:
125125
* For tests run in a non-production environment like minikube, a kubernetes Physical Volume (PV) can be created and
126126
and mounted in the test container for the post-test script to copy its result files into. The higher level test-logic flow on one's
127-
development system (or CICD engine like Travis/Jenkins) can then copy out the test result and coverage files.
127+
development system (or CI/CD engine like Travis/Jenkins) can then copy out the test result and coverage files.
128128

129129
* Utilize a state-handshake between the high level test scripting (eg. Travis/Jenkins/laptop shell) and the process in the
130130
test pod. This can be done with a file in the pod, where the test scripting writes the process return-code from the tests to that file and

docs/development/mono-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ While there are a benefits, there are challenges to overcome.
6565
* Detecting what to build. Build times can be long due to overbuilding the entire repository
6666
* Long build times. Because of having to build the entire repository, this will cause build times to increase because tooling no longer is just building one artifact/package, but many different ones.
6767
* Not just JavaScript. A monorepo may not just be JavaScript, and can impact organization, tooling, and how to approach building different artifacts or packages in different languages.
68-
* Git repositories can grow larger in size. Since we are building and maintaing different packages in a singular repository, we can exponentially grow the size of the git repository.
68+
* Git repositories can grow larger in size. Since we are building and maintaining different packages in a singular repository, we can exponentially grow the size of the git repository.
6969
* Commit messages can be harder to interpret due to multiple artifacts, packages, or teams.
7070

7171

docs/development/npm-package-development.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ to the public npm registry
8989

9090
* **private** - This field is only recommended and should be set to `yes` if your package will not be published to npm.
9191

92-
* **support** - This field is to help package maintainers communicate with and set expectations for their users about the level of support they are willing to provide on a package. The team has worked closely with the [Node.js Package Maintence Team](https://github.com/nodejs/package-maintenance) on their recommendations on what this support field should look like. For one of your modules, [opossum](https://github.com/nodeshift/opossum), we [set this field](https://github.com/nodeshift/opossum/blob/main/package.json#L75) to `true` and supplied our support information in a separate [package-support.json file](https://github.com/nodeshift/opossum/blob/main/package-support.json).
92+
* **support** - This field is to help package maintainers communicate with and set expectations for their users about the level of support they are willing to provide on a package. The team has worked closely with the [Node.js Package Maintenance Team](https://github.com/nodejs/package-maintenance) on their recommendations on what this support field should look like. For one of your modules, [opossum](https://github.com/nodeshift/opossum), we [set this field](https://github.com/nodeshift/opossum/blob/main/package.json#L75) to `true` and supplied our support information in a separate [package-support.json file](https://github.com/nodeshift/opossum/blob/main/package-support.json).
9393

94-
For more information on the support field, check out what the [Package Maintence Team says](https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md)
94+
For more information on the support field, check out what the [Package Maintenance Team says](https://github.com/nodejs/package-maintenance/blob/main/docs/PACKAGE-SUPPORT.md)
9595

9696
* **type** - This field defines the module format that Node.js will use. For ES Modules(ESM), use `module` and for Common JS(CJS) modules, use `commonjs`. For more information on how Node.js determines the difference between ESM and CJS modules take a [look at the Node.js official docs here](https://nodejs.org/dist/latest-v18.x/docs/api/packages.html#determining-module-system)
9797

@@ -105,9 +105,9 @@ While there is no list of development dependencies that the team recommends, we
105105

106106
For the teams guidance on choosing dependencies, check out the [Choosing and vetting dependencies](./dependencies.md).
107107

108-
During development of a pacakge, it is helpful to add the package-lock.json to source control, so all developers working on the package will be able to install the same versions of dependencies.
108+
During development of a package, it is helpful to add the package-lock.json to source control, so all developers working on the package will be able to install the same versions of dependencies.
109109

110-
It is also recommended to know what semver range you are specifying for any dependecy you wish to install. For example:
110+
It is also recommended to know what semver range you are specifying for any dependency you wish to install. For example:
111111

112112
The `^` will give you all the minor and patch releases when they become available.
113113

@@ -123,7 +123,7 @@ npm Workspaces supports managing multiple projects within a singular top-level,
123123

124124
### Bundlers and Transpilers
125125

126-
Bundlers are helpful if your package needs to be used by both Node.js and the browser. The same codebase can be packaged for multiple platforms with a trivial amount of work by using a bundler. [Webpack](https://webpack.js.org/) is one such bundler that the team has some familarity with.
126+
Bundlers are helpful if your package needs to be used by both Node.js and the browser. The same codebase can be packaged for multiple platforms with a trivial amount of work by using a bundler. [Webpack](https://webpack.js.org/) is one such bundler that the team has some familiarity with.
127127

128128
For those packages being written in Typescript, you will need to use a transpiler since Node.js does not support running TypeScript natively, so it must first be transpiled to JavaScript. We recommend the `tsc` transpiler that is shipped with [typescript](https://www.npmjs.com/package/typescript). This supports both type checking and transpilation to JavaScript.
129129

0 commit comments

Comments
 (0)