change outline

Signed-off-by: Zach Aller <[email protected]>

api/v1alpha1/commitstatus_types.go

@@ -31,14 +31,18 @@ type CommitStatusSpec struct {
 	// +kubebuilder:validation:Required
 	RepositoryReference *Repository `json:"repository"`
 
+	// Sha is the commit sha to report the status for
 	// +kubebuilder:validation:Required
 	Sha string `json:"sha"`
 
+	// Name is the name of the status check
 	// +kubebuilder:validation:Required
 	Name string `json:"name"`
 
+	// Description is the description of the status check
 	Description string `json:"description"`
 
+	// Phase is the state of the status check it can be one of pending, success, failure
 	// +kubebuilder:validation:Required
 	// +kubebuilder:default:=pending
 	// +kubebuilder:validation:Enum:=pending;success;failure
@@ -47,6 +51,7 @@ type CommitStatusSpec struct {
 	// (Gitlab: pending, running, success, failed, canceled)
 	// (Bitbucket: INPROGRESS, STOPPED, SUCCESSFUL, FAILED)
 
+	// Url is the url to the status check to provide more information
 	Url string `json:"url"`
 }
 

docs/index.md

@@ -12,4 +12,6 @@ GitOps Promoter is a tool designed to facilitate environment promotion in a GitO
 
 ## Getting Started
 
-To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md).
+To get started with GitOps Promoter, follow the [installation guide](installation.md) and the [basic usage instructions](getting-started.md).
+
+## Concepts of Promotion

mkdocs.yml

@@ -18,7 +18,10 @@ theme:
         name: Switch to light mode
 nav:
   - Overview: index.md
-  - Installation: installation.md
+  - Installation:
+      - Installation: installation.md
+      - Github Application Configuration: github-app-configuration.md
   - Getting Started:
       - Basic Usage: getting-started.md
       - Non-Kubernetes Usage: non-kubernetes-usage.md
+  - CRD Reference: crd-reference.md