Skip to content

Commit

Permalink
Fix spelling and typos in docs, code variables and code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
chocnut committed Nov 20, 2019
1 parent 05eec83 commit 4adc5cc
Show file tree
Hide file tree
Showing 26 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Alpha releases should never be installed automatically when the user installs /

Assuming our current version is `v1.1.0`.

The alpha releas would be `v1.2.0-alpha.1`. A subsequent alpha release would be `v1.2.0-alpha.2` etc.
The alpha release would be `v1.2.0-alpha.1`. A subsequent alpha release would be `v1.2.0-alpha.2` etc.
2 changes: 1 addition & 1 deletion VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

For the framework we follow Semantic Versioning as defined on [http://semver.org/](http://semver.org).

## Intepretation of SemVer for the Framework
## Interpretation of SemVer for the Framework

### PATCH

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/monitoring/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ As part of the Serverless Insights feature we also include a set of pre-configur

## Errors and Invocations

The errors and invociations chart shows error count trends and the aggregate number of invocations for a particular service for a selected time period. Click into any bar on the chart to see function specific metrics.
The errors and invocations chart shows error count trends and the aggregate number of invocations for a particular service for a selected time period. Click into any bar on the chart to see function specific metrics.

## Durations

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboard/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Create a new stage by navigating to **applications** in the [Serverless Framewor
2. Click **add stage** in the tab
3. Provide the **name** and select the **deployment profile**.

You can also set the **default deployment profile** field in the application. You can use this to set the deployment profile on all sevices in that application. When deploying to a stage which hasn't be defined in the dashboard, then the default deployment profile will be used.
You can also set the **default deployment profile** field in the application. You can use this to set the deployment profile on all services in that application. When deploying to a stage which hasn't be defined in the dashboard, then the default deployment profile will be used.

### Using a Deployment Profile to deploy

Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard/safeguards/available.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ https://serverless.com/framework/docs/providers/aws/guide/functions/#vpc-configu
**ID: allowed-function-names**

This rule allows you enforce naming conventions functions deployed to AWS lambda.
It is confgured with a regular expression. It features one extra addition: variables for stage,
It is configured with a regular expression. It features one extra addition: variables for stage,
service and function(the key in the serverless yaml) names. See below for some examples.

Require using Serverless's standard naming scheme:
Expand Down Expand Up @@ -236,7 +236,7 @@ This policy blocks deploys at certain times. It is configured with a list of obj
time, duration and optional interval.

```yaml
# no deploy specific holidiays, eg Rosh Hashanah 2019
# no deploy specific holidays, eg Rosh Hashanah 2019
- time: 2019-09-29T18:20 # ISO8601 date or datetime
duration: P2D30M # IS8601 duration
# no deploy a specific day but repeating, eg all future Christmases
Expand Down
8 changes: 4 additions & 4 deletions docs/dashboard/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If we add a test like this which requires the body to be JSON encoded and contai
foo: bar
```

Then when we run `sls test` we get the details of the faiulre:
Then when we run `sls test` we get the details of the failure:

```
$ sls test
Expand Down Expand Up @@ -87,7 +87,7 @@ Here is a config file that uses all the options:
```yaml
- name: hello endpoint returns success # the name of the test. used for running a specific test & in CLI output
endpoint: # this is used to specify which HTTP endpoint / lambda to test against
# specifying only the funciton name only works if the function has only one HTTP endpoint and
# specifying only the function name only works if the function has only one HTTP endpoint and
# a specific path & method (i.e. not ANY or {parameterizedUrls})
function: hello
response: true # setting response to true is equivalent to setting it to {status: 200}
Expand All @@ -110,15 +110,15 @@ Here is a config file that uses all the options:
body: # setting body to an object json encodes it & adds the correct content-type header
foo: bar
blah: baz
- name: hello endpoint returns sucess with a form request
- name: hello endpoint returns success with a form request
endpoint:
function: hello
response: true
request:
form: # setting form encodes to a query param, i.e.: ?foo=bar&blah=baz
foo: bar
blah: baz
- name: hello endpoint returns sucess with a text request
- name: hello endpoint returns success with a text request
endpoint:
function: hello
response: true
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aliyun/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Serverless is a [Node.js](https://nodejs.org) CLI tool so the first thing you ne

Go to the official [Node.js website](https://nodejs.org), download and follow the [installation instructions](https://nodejs.org/en/download/) to install Node.js on your local machine.

You can verify that Node.js is installed successfully by runnning `node --version` in your terminal. You should see the corresponding Node version number printed out.
You can verify that Node.js is installed successfully by running `node --version` in your terminal. You should see the corresponding Node version number printed out.

### Installing the Serverless Framework

Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aws/events/alexa-skill.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ functions:

The previous syntax of this event didn't require a skill ID as parameter, but according to [Amazon's documentation](https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#configuring-the-alexa-skills-kit-trigger) you should restrict your lambda function to be executed only by your skill.

Omitting the skill id will make your Lambda function publically available, which will allow any other skill developer to invoke it.
Omitting the skill id will make your Lambda function publicly available, which will allow any other skill developer to invoke it.

(This is important, as [opposed to custom HTTPS endpoints](https://developer.amazon.com/docs/custom-skills/handle-requests-sent-by-alexa.html#request-verify), there's no way to validate the request was sent by your skill.)
2 changes: 1 addition & 1 deletion docs/providers/aws/events/cloudwatch-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ functions:

## Specifying a Name

You can also specify a CloudWatch Event name. Keep in mind that the name must begin with a letter; contain only ASCII letters, digits, and hyphens; and not end with a hyphen or contain two consecutive hyphens. More infomation [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
You can also specify a CloudWatch Event name. Keep in mind that the name must begin with a letter; contain only ASCII letters, digits, and hyphens; and not end with a hyphen or contain two consecutive hyphens. More information [here](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).

```yml
functions:
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aws/examples/hello-world/csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Make sure `serverless` is installed. [See installation guide](../../../guide/ins

Once installed the Serverless CLI can be called with `serverless` or the shorthand `sls` command.

If `sls` command retuns an error in PowerShell, please use `serverless` command.
If `sls` command returns an error in PowerShell, please use `serverless` command.

```
$ sls
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aws/examples/hello-world/go/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Create a Go Hello World Lambda function
layout: Doc
-->

<!-- DOCS-SITE-LINK:START automatically geneated -->
<!-- DOCS-SITE-LINK:START automatically generated -->

### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/examples/hello-world/go/)

Expand Down
4 changes: 2 additions & 2 deletions docs/providers/aws/guide/serverless.yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ provider:
restApiResources: # List of existing resources that were created in the REST API. This is required or the stack will be conflicted
'/users': xxxxxxxxxx
'/users/create': xxxxxxxxxx
websocketApiId: # Websocket API resource ID. Default is generated by the framewok
websocketApiId: # Websocket API resource ID. Default is generated by the framework
apiKeySourceType: HEADER # Source of API key for usage plan. HEADER or AUTHORIZER.
minimumCompressionSize: 1024 # Compress response when larger than specified size in bytes (must be between 0 and 10485760)
description: Some Description # Optional description for the API Gateway stage deployment
Expand Down Expand Up @@ -208,7 +208,7 @@ functions:
resultTtlInSeconds: 0
identitySource: method.request.header.Authorization
identityValidationExpression: someRegex
type: token # token or request. Determines input to the authorier function, called with the auth token or the entire request event. Defaults to token
type: token # token or request. Determines input to the authorizer function, called with the auth token or the entire request event. Defaults to token
- websocket:
route: $connect
authorizer:
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/aws/guide/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ functions:
events: ${file(./myCustomFile.yml):myevents}
```

or for a JSON reference file use this sytax:
or for a JSON reference file use this syntax:

```yml
functions:
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/azure/guide/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ layout: Doc

# Azure - Introduction

The Serverless Framework helps you develop and deploy serverless applications using Azure Functions. It's a CLI that offers structure, automation and best practices for deployment of both code and infrstructure, allowing you to focus on building sophisticated, event-driven, serverless architectures, comprised of [Functions](#functions) and [Events](#events).
The Serverless Framework helps you develop and deploy serverless applications using Azure Functions. It's a CLI that offers structure, automation and best practices for deployment of both code and infrastructure, allowing you to focus on building sophisticated, event-driven, serverless architectures, comprised of [Functions](#functions) and [Events](#events).

## Core Concepts

Expand Down
2 changes: 1 addition & 1 deletion docs/providers/azure/guide/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Intro. Quick recommendations and tips for various processes.

1. Write your functions
2. Run function app locally by using `sls offline` and `npm start` (or `func host start`). See [quickstart](./quick-start).
3. Use `serverless deploy` to deploy your function app (preferrably in a CI/CD environment)
3. Use `serverless deploy` to deploy your function app (preferably in a CI/CD environment)
4. Use `serverless invoke -f myFunction` to test your Azure Functions.

### Larger Projects
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/cloudflare/guide/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ provider:
`stage`: meant to be the stage of your project (`dev`, `prod`..). Will be used in the [`name`](#name) of the scripts on deployed to Cloudflare. If unset defaults to `dev`.
`environment`: variables that can be referenced in your throughout your worker scripts. These will get added to every function. If a [`function`](#function) defines the same variable, the function defintion will overwrite the provider block definition.
`environment`: variables that can be referenced in your throughout your worker scripts. These will get added to every function. If a [`function`](#function) defines the same variable, the function definition will overwrite the provider block definition.
`name`: the name of the cloud provider, in this case `cloudflare`
Expand Down
2 changes: 1 addition & 1 deletion docs/providers/fn/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ serverless create --template-url https://myUsername:[email protected]/

This will copy the content of your repository into `/path/to/my/service` and rename the service to `my-new-service`.

In order to use this feature, you need to have a Bitbucket Server with the Rest-API available and the endpoint `/rest/api/1.0/application-properties` accessible with no authentification (default behaviour). This endpoint is used to identify if the given DNS is attached to a Bitbucket server. The repository is downloaded over HTTP(S) as a ZIP file using the following api [https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm8297859856](https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm8297859856)
In order to use this feature, you need to have a Bitbucket Server with the Rest-API available and the endpoint `/rest/api/1.0/application-properties` accessible with no authentication (default behavior). This endpoint is used to identify if the given DNS is attached to a Bitbucket server. The repository is downloaded over HTTP(S) as a ZIP file using the following api [https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm8297859856](https://docs.atlassian.com/bitbucket-server/rest/5.16.0/bitbucket-rest.html#idm8297859856)
2 changes: 1 addition & 1 deletion lib/classes/CLI.js
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ functionalities related to given service or current environment.`
// remove subcommand from clone
delete pcmd.commands;

// check if a plugin entry is alreay present in pluginCommands. Use the
// check if a plugin entry is already present in pluginCommands. Use the
// existing one or create a new plugin entry.
if (_.has(pluginCommands, pcmd.pluginName)) {
pluginCommands[pcmd.pluginName] = pluginCommands[pcmd.pluginName].concat(pcmd);
Expand Down
2 changes: 1 addition & 1 deletion lib/classes/PluginManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ class PluginManager {
let options = resolverOrOptions;
if (!options) {
this.serverless.cli.log(
`Warning! Ignoring falsey variableResolver for ${variablePrefix} in ${pluginName}.`
`Warning! Ignoring falsy variableResolver for ${variablePrefix} in ${pluginName}.`
);
continue;
}
Expand Down
10 changes: 5 additions & 5 deletions lib/classes/Variables.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const PromiseTracker = require('./PromiseTracker');
* Original issue #4687
* 2. The resolution of variables can get very confusing if the same object is used multiple times.
* An example of this is the print command which *implicitly/invisibly* populates the
* serverless.yml and then *explicitly/visibily* renders the same file again, without the
* serverless.yml and then *explicitly/visibly* renders the same file again, without the
* adornments that the framework's components make to the originally loaded service. As a result,
* it is important to reset this object for each use.
* 3. Note that despite some AWS code herein that this class is used in all plugins. Obviously
Expand Down Expand Up @@ -110,8 +110,8 @@ class Variables {
const dependencyMessage = (configValue, serviceName) =>
`Variable dependency failure: variable '${configValue}' references ${serviceName} but using that service requires a concrete value to be called.`;
// replace and then restore the methods for obtaining values from dependent services. the
// replacement naturally rejects dependencies on these services that occur during prepopulation.
// prepopulation is, of course, the process of obtaining the required configuration for using
// replacement naturally rejects dependencies on these services that occur during pre-population.
// pre-population is, of course, the process of obtaining the required configuration for using
// these services.
for (const resolver of this.variableResolvers) {
if (resolver.isDisabledAtPrepopulation) {
Expand Down Expand Up @@ -174,7 +174,7 @@ class Variables {
return BbPromise.resolve();
}
/**
* Populate all variables in the service, conviently remove and restore the service attributes
* Populate all variables in the service, conveniently remove and restore the service attributes
* that confuse the population methods.
* @param processedOptions An options hive to use for ${opt:...} variables.
* @returns {Promise.<TResult>|*} A promise resolving to the populated service.
Expand Down Expand Up @@ -493,7 +493,7 @@ class Variables {
const matchContained = contained(match);
const containedBy = stringMatches.find(matchContained);
if (!containedBy) {
// if uncontained, this comma respresents a splitting location
// if uncontained, this comma represents a splitting location
commaReplacements.push({
start: match.index,
end: this.overwriteSyntax.lastIndex,
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/aws/deploy/lib/checkForChanges.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ module.exports = {
});
},

// Gives the least recent last modify date accross all the functions in the service.
// Gives the least recent last modify date across all the functions in the service.
getFunctionsEarliestLastModifiedDate() {
const getFunctionResults = this.serverless.service.getAllFunctions().map(funName => {
const functionObj = this.serverless.service.getFunction(funName);
Expand Down
8 changes: 4 additions & 4 deletions lib/plugins/aws/package/compile/functions/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class AwsCompileFunctions {

compileRole(newFunction, role) {
const compiledFunction = newFunction;
const unnsupportedRoleError = new this.serverless.classes.Error(
const unsupportedRoleError = new this.serverless.classes.Error(
`Unsupported role provided: "${JSON.stringify(role)}"`
);

Expand All @@ -50,12 +50,12 @@ class AwsCompileFunctions {
// role is an "Fn::ImportValue" object
compiledFunction.Properties.Role = role;
} else {
throw unnsupportedRoleError;
throw unsupportedRoleError;
}
break;
case 'string':
if (role.startsWith('arn:aws')) {
// role is a statically definied iam arn
// role is a statically defined iam arn
compiledFunction.Properties.Role = role;
} else if (role === 'IamRoleLambdaExecution') {
// role is the default role generated by the framework
Expand All @@ -70,7 +70,7 @@ class AwsCompileFunctions {
}
break;
default:
throw unnsupportedRoleError;
throw unsupportedRoleError;
}
}

Expand Down
4 changes: 2 additions & 2 deletions lib/plugins/aws/provider/awsProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ class AwsProvider {

Object.assign(this.naming, naming);

// Activate AWS SDK loggin
// Activate AWS SDK logging
if (process.env.SLS_DEBUG) {
AWS.config.logger = this.serverless.cli;
}
Expand Down Expand Up @@ -287,7 +287,7 @@ class AwsProvider {
const awsService = new that.sdk[service](credentials);
const req = awsService[method](params);

// TODO: Add listeners, put Debug statments here...
// TODO: Add listeners, put Debug statements here...
// req.on('send', function (r) {console.log(r)});

const promise = req.promise
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/install/install.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class Install {
].join('');
userStats.track('service_installed', {
data: {
// will be updated with core analtyics lib
// will be updated with core analytics lib
url: this.options.url,
},
});
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/package/lib/packageService.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ module.exports = {
const zipFileName = `${this.serverless.service.service}.zip`;
/*
* crosscompiled GoLang binaries on windows don't have their execute bit set correctly.
* This is nearly imposible to actually set on a windows machine, so find all the Go handler
* This is nearly impossible to actually set on a windows machine, so find all the Go handler
* files and pass them into zipFiles as files to add with the execute bit in the zip file
*/
const filesToChmodPlusX =
Expand Down
4 changes: 2 additions & 2 deletions lib/utils/log/fileLog.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ const fs = require('fs');
const path = require('path');

const fileLog = function(...args) {
// TODO BRN: This does not guarentee order, is not multi process safe,
// TODO BRN: and is not guarenteed to complete before exit.
// TODO BRN: This does not guarantee order, is not multi process safe,
// TODO BRN: and is not guaranteed to complete before exit.
fs.appendFileSync(path.join(process.cwd(), 'sls.log'), `${_.join(args)}\n`);
};

Expand Down

0 comments on commit 4adc5cc

Please sign in to comment.