From fa4bf1d76540e28dab4152e237ce571d9298cf4b Mon Sep 17 00:00:00 2001 From: Lucas Brown Date: Wed, 14 Aug 2019 01:18:21 -0800 Subject: [PATCH] Updates to readme files to fix some misspellings. --- README.md | 12 ++++++------ cmd/web-api/README.md | 2 +- cmd/web-app/README.md | 2 +- tools/devops/README.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 484939c..c5fb683 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ delivered to clients. a knowledge of a completely different expertise - DevOps. This project provides a complete continuous build pipeline that will push the code to production with minimal effort using serverless deployments to AWS Fargate with GitLab CI/CD. 5. Observability - Ensure the code is running as expected in a remote environment. This project implements Datadog to -facilitate exposing metrics, logs and request tracing to obversabe and validate your services are stable and responsive +facilitate exposing metrics, logs and request tracing to obverse and validate your services are stable and responsive for your clients (hopefully paying clients). @@ -71,7 +71,7 @@ facilitate exposing metrics, logs and request tracing to obversabe and validate The example project is a complete starter kit for building SasS with GoLang. It provides two example services: * Web App - Responsive web application to provide service to clients. Includes user signup and user authentication for direct client interaction via their web browsers. -* Web API - REST API with JWT authentication that renders results as JSON. This allows clients and other third-pary companies to develop deep +* Web API - REST API with JWT authentication that renders results as JSON. This allows clients and other third-party companies to develop deep integrations with the project. The example project also provides these tools: @@ -106,7 +106,7 @@ Accordingly, the project architecture is illustrated with the following diagram. With SaaS, a client subscribes to an online service you provide them. The example project provides functionality for clients to subscribe and then once subscribed they can interact with your software service. -The initial contributors to this project are building this saas-starter-kit based on their years of experience building enterprise B2B SaaS. Particularily, this saas-starter-kit is based on their most recent experience building the +The initial contributors to this project are building this saas-starter-kit based on their years of experience building enterprise B2B SaaS. Particularly, this saas-starter-kit is based on their most recent experience building the B2B SaaS for [standard operating procedure software](https://keeni.space) (written entirely in Golang). Please refer to the Keeni.Space website, its [SOP software pricing](https://keeni.space/pricing) and its signup process. The SaaS web app is then available at [app.keeni.space](https://app.keeni.space). They plan on leveraging this experience and build it into a simplified set @@ -175,7 +175,7 @@ $ git clone git@gitlab.com:geeks-accelerator/oss/saas-starter-kit.git $ cd saas-starter-kit/ ``` -If you have Go Modules enabled, you should be able compile the project locally. If you have Go Modulels disabled, see +If you have Go Modules enabled, you should be able compile the project locally. If you have Go Modules disabled, see the next section. @@ -386,7 +386,7 @@ Policy Document: { } ``` -Create a new user with programic access and directly attach it the policy `SaasStarterKitDevServices` +Create a new user with programmatic access and directly attach it the policy `SaasStarterKitDevServices` 4. Create a new docker-compose config file ```bash @@ -395,7 +395,7 @@ Create a new user with programic access and directly attach it the policy `SaasS 5. Update .env_docker_compose with the Access key ID and Secret access key -6. Update `.gitlab-ci.yml` with relevent details. +6. Update `.gitlab-ci.yml` with relevant details. ### Optional. Set AWS and Datadog Configs diff --git a/cmd/web-api/README.md b/cmd/web-api/README.md index 4aa4612..31eeb01 100644 --- a/cmd/web-api/README.md +++ b/cmd/web-api/README.md @@ -254,7 +254,7 @@ swag init ### Additional Swagger Annotations -Below are some additional example annotions that can be added to `main.go` +Below are some additional example annotations that can be added to `main.go` ```go // @title SaaS Example API // @description This provides a public API... diff --git a/cmd/web-app/README.md b/cmd/web-app/README.md index fb718d7..83f75b8 100644 --- a/cmd/web-app/README.md +++ b/cmd/web-app/README.md @@ -24,7 +24,7 @@ http://127.0.0.1:3000/ While the web-api service has significant functionality, this web-app service is still in development. Currently this web-app services only resizes -an image and displays resvised versions of it on the index page. See section below on Future Functionality. +an image and displays resized versions of it on the index page. See section below on Future Functionality. If you would like to help, please email twins@geeksinthewoods.com. diff --git a/tools/devops/README.md b/tools/devops/README.md index 1b1f8e2..7a6acad 100644 --- a/tools/devops/README.md +++ b/tools/devops/README.md @@ -26,7 +26,7 @@ in other configuration files. And since this project is open-source, we wanted t If you don't have an AWS account, signup for one now and then proceed with the deployment setup. -We assume that if you are deploying the SaaS Stater Kit, you are starting from scratch with no existing dependencies. +We assume that if you are deploying the SaaS Starter Kit, you are starting from scratch with no existing dependencies. This however, excludes any domain names that you would like to use for resolving your services publicly. To use any pre-purchased domain names, make sure they are added to Route 53 in the AWS account. Or you can let the deploy script create a new zone is Route 53 and update the DNS for the domain name when your ready to make the transition. It is