This repository contains user-level documentation for our product & service offering, as well as documentation on tools and best practices. The main target audience are the Skyscrapers customers.
In this knowledge base you'll find information on how to use your Kubernetes cluster, how to create a Concourse pipeline, how to manage containerized applications and how to monitor them, etc. You'll also find some opinionated good practices, tips and recommendations, along with references to external sources of documentation and articles. It's intended to be browsed mainly through GitHub or a local git clone, so the file tree acts as the table of contents.
Each header points to the main README of each platform offering. Within each folder you'll also find documentation on more advanced and/or specific topics.
- AWS
- Backups
- Coding Guidelines and Best Practices - Main coding guidelines we adhere to at Skyscrapers
- Concourse - Walk-through on how to use Concourse and setup pipelines
- Kubernetes - Walk-through on getting access to and deploying applications on our K8s clusters
- MongoDB Atlas
- Onboarding - All resources related to the onboarding track
- Kubernetes Platform Orientation - Kubernetes Platform Orientation workshop material
- Runbook - Description of our custom monitoring alerts with possible remediations
Your contributions are very welcomed, so if you have any suggestions to improve this documentation feel free to open an issue or a pull request. In any case, it's important that you keep in mind the following guidelines:
- All documentation in this repo is written in Markdown and must be compliant with GitHub Flavoured Markdown (GFM)
- File and folder names should be descriptive enough to let the reader know what's in them
- Make sure to update the main ToC above