Cloud-Native Docs for GlueOps
GlueOps had scattered documentation across multiple GitHub repos with no central reference. Developers and users had to know which repo to look in, and even then the documentation within each repo was inconsistent in format and depth.
The Problem
The information existed, but it was unfindable. Deployment processes for Docker Hub, GCP, GitHub, AWS, Azure, Terraform, and Quay each lived in different repositories. There was no consistent format, no central navigation, and no way for a new user to understand the full picture.
Centralising into a Unified Docusaurus Site
I built a unified Docusaurus site that brought together deployment documentation across all seven platforms. Each platform had its own deployment process and configuration requirements, and the documentation needed to be clear enough that someone could follow it without prior context on GlueOps’ infrastructure.
Covering the Full Deployment Surface
The documentation covered:
- AWS account setup and service quota configuration
- GCP project setup and permissions
- GitHub App and OAuth configuration for the platform integration
- Docker Hub deployment workflows
- Terraform infrastructure definitions
- Environment secrets management
- First app deployment guides
The Outcome
It was a short engagement, but the impact was straightforward: before, the information existed but was unfindable. After, it was organised, searchable, and maintained in one place. New team members and users could find what they needed without asking.