GROUP-81 Update documentation. Update commit-stage.yml

.github/workflows/commit-stage.yml

@@ -51,7 +51,8 @@ jobs:
  - name: Validate Kubernetes manifests
  run: |
  arkade get kubeconform
- kustomize build k8s | kubeconform -strict -summary -output json
+ kustomize build k8s/base | kubeconform -strict -summary -output json
+ kustomize build k8s/overlays/observability | kubeconform -strict -summary -output json
  package:
  name: Package and Publish
  if: ${{ github.ref == 'refs/heads/main' }}

README.md

@@ -1,5 +1,8 @@
+_This README is a work in progress. Some steps may be incomplete or missing_
+
 # edge-service
-Edge Service serves as an API Gateway to connect users to downstream services while managing cross-cutting concerns such as:
+Edge Service serves as an API Gateway to connect users to downstream services while managing cross-cutting concerns such 
+as:
 
 - Centralized routing
 - Circuit breakers
@@ -9,11 +12,12 @@ Edge Service serves as an API Gateway to connect users to downstream services wh
 
 <hr>
 
+## Contents
 - [Group Service Architecture](#Edge-Service-Architecture)
  - [Component Diagram](#Component-Diagram)
 
 ## Edge Service Architecture
-The following container diagram shows Edge Services's place in the GroupHQ Software System. 
+The following container diagram shows Edge Service's place in the GroupHQ Software System. 
 Shown in the diagram, Edge Service communicates with three downstream services (Session Store, Group Sync, and the frontend application), while being called by the user.
 <br>