From ef43256d4a635817740c4636d506bae774c74f41 Mon Sep 17 00:00:00 2001 From: Andrew Hughes Date: Fri, 20 Sep 2019 15:08:20 +0100 Subject: [PATCH 1/2] fix: typos in readme --- experimental/nodejs-functions/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/experimental/nodejs-functions/README.md b/experimental/nodejs-functions/README.md index 9b3e3723a..052fd9497 100644 --- a/experimental/nodejs-functions/README.md +++ b/experimental/nodejs-functions/README.md @@ -1,6 +1,6 @@ # Node.js Functions Stack -The Node.js Functions stack extends the [Node.js Express stack](../../incubator/nodejs-express/README.md) and provides a way for you to build one or more individual functions using the "Connect Middeware" API from Express.js: +The Node.js Functions stack extends the [Node.js Express stack](../../incubator/nodejs-express/README.md) and provides a way for you to build one or more individual functions using the "Connect Middleware" API from Express.js: ```js var handler = function handler(req, res, next) { @@ -8,7 +8,7 @@ var handler = function handler(req, res, next) { } ``` -These are then applied onto the pre-configured Express.js from the Node.js Express stack, which provides pre-confugured cloud-native capabilities include health checking and application metrics, along with installing a performance monitoring and analysis dashboard during development. +These are then applied onto the pre-configured Express.js from the Node.js Express stack, which provides pre-configured cloud-native capabilities include health checking and application metrics, along with installing a performance monitoring and analysis dashboard during development. This stack is based on `Node.js v10` and `Express v4.16.0`, as derived from the [Node.js Express stack](../../incubator/nodejs-express/README.md). @@ -66,7 +66,7 @@ module.exports.get = function(req, res, next) { } ``` -If you wish to have multiple functions as part of your project, simply create an additonal `.js` file in your folder to contain the function. +If you wish to have multiple functions as part of your project, simply create an additional `.js` file in your folder to contain the function. Note that you can also `require` any modules that you wish to use but adding them to the `package.json` and adding a `require` statement into your function files as you would normally. From 94c9cf57451bb9a94420d4d531153d11594996d7 Mon Sep 17 00:00:00 2001 From: Andrew Hughes Date: Sat, 21 Sep 2019 10:25:49 +0100 Subject: [PATCH 2/2] docs: general typos --- README.md | 8 ++++---- TECHNICAL_REQUIREMENTS.md | 2 +- incubator/nodejs/README.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b94d26618..e410d7f80 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,20 @@ Infused with cloud native capabilities from the moment you start, Appsody provid # Stacks -This respository holds the default set of stacks available from Appsody. Each stack is pre-configured with popular open source technologies to enable rapid development of quality microservice-based applications. Stacks include a base container image and project templates which act as a starting point for your application development. +This repository holds the default set of stacks available from Appsody. Each stack is pre-configured with popular open source technologies to enable rapid development of quality microservice-based applications. Stacks include a base container image and project templates which act as a starting point for your application development. Stacks allow for rapid development whilst giving the stack developer the ability to control the overall applications that are created from it. To find out more about Appsody check out [appsody.dev](https://appsody.dev). ## Repository Structure -Stacks are catagorized as either stable, incubator or experimental depending on the content of the stack. +Stacks are categorized as either stable, incubator or experimental depending on the content of the stack. - `stable/`: Stable stacks meet this set of [technical requirements](https://github.com/appsody/stacks/blob/master/TECHNICAL_REQUIREMENTS.md). -- `incubator/:` The stacks in the incubator folder are actively being worked on to satisfy the stable critria. +- `incubator/:` The stacks in the incubator folder are actively being worked on to satisfy the stable criteria. -- `experimental/:` Exprimental stacks are not being actively been worked on and may not fulfill the requirements of an Appsody stack. These can be used for trying out specific capabilites or proof of concept work. +- `experimental/:` Experimental stacks are not being actively been worked on and may not fulfill the requirements of an Appsody stack. These can be used for trying out specific capabilities or proof of concept work. Click here to find out more about [Appsody stacks](https://github.com/appsody/website/blob/master/content/docs/stacks/stacks-overview.md). diff --git a/TECHNICAL_REQUIREMENTS.md b/TECHNICAL_REQUIREMENTS.md index ad82d2c02..e8dcfb8c2 100644 --- a/TECHNICAL_REQUIREMENTS.md +++ b/TECHNICAL_REQUIREMENTS.md @@ -2,7 +2,7 @@ All stable stacks must: - Adhere to the [Structure of a stack](https://github.com/appsody/website/blob/master/content/docs/stacks/stack-structure.md) -- Support all the Appsody CLI commmands +- Support all the Appsody CLI commands - Support all the operating systems supported by Appsody, today this list includes: - macOS Mojave - Ubuntu 18.04.2 diff --git a/incubator/nodejs/README.md b/incubator/nodejs/README.md index 7fa72e803..f9462186d 100644 --- a/incubator/nodejs/README.md +++ b/incubator/nodejs/README.md @@ -4,7 +4,7 @@ The Node.js stack provides a consistent way of developing [Node.js](https://node This stack is based on the `Node.js v10` runtime and allows you to develop new or existing Node.js application using Appsody. -Additionally, if you are developing an applicaton that includes a HTTP server or a web framework such as Express.js,the stack provides a built-in application performance dashboard using the [appmetrics-dash](https://github.com/runtimetools/appmetrics-dash) module. This makes it easy to see the resource usage and HTTP endpoint performance of your application as it is developed. +Additionally, if you are developing an application that includes a HTTP server or a web framework such as Express.js,the stack provides a built-in application performance dashboard using the [appmetrics-dash](https://github.com/runtimetools/appmetrics-dash) module. This makes it easy to see the resource usage and HTTP endpoint performance of your application as it is developed. The dashboard is only included during development, and is not included in images build using `appsody build`.