docs: first pass at some docs

api/v1alpha1/commitstatus_types.go

@@ -31,14 +31,18 @@ type CommitStatusSpec struct {
 	// +kubebuilder:validation:Required
 	RepositoryReference ObjectReference `json:"gitRepositoryRef"`
 
+	// 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

@@ -1,17 +1,15 @@
-# Welcome to MkDocs
+# Welcome to GitOps Promotions
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+GitOps Promoter is a tool designed to facilitate environment promotion in a GitOps fashion. It automates the process of promoting changes from one environment to the next by leveraging Git operations. The tool can help ensures that your environments are always in sync with the desired state defined in your Git repository when used with a CD tool like ArogCD.
 
-## Commands
+## Key Features
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+- **Automated Environment Promotion**: Seamlessly promote changes across environments.
+- **GitOps First**: Adheres to GitOps principles, ensuring that all changes are version-controlled.
+- **YAML Diff Detection**: Detects changes in YAML files to determine if a pull request is required.
+- **Integration with CI/CD**: Easily integrates with your existing CI/CD pipelines.
+- **ArgoCD Integration**: Supports ArgoCD when managing Kubernetes resources.
 
-## Project layout
+## What is GitOps promotion.
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+GitOps promotion is the process of promoting changes across environments in a GitOps fashion. It involves using Git operations to manage the promotion of changes from one environment to the next. This ensures that all changes are version-controlled and that environments are always in sync with the desired state defined in your Git repository.

mkdocs.yml

@@ -22,9 +22,10 @@ markdown_extensions:
       css_class: highlight
 nav:
   - Overview: index.md
-  - Installation: installation.md
-  - Concepts: concepts.md
-  - Architecture: architecture.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 Specs: crd-specs.md