Overview
A high level overview of the SpinKube sub-projects.
SpinKube documentation
Everything you need to know about SpinKube.
First steps
To get started with SpinKube, follow our Quickstart guide.
How the documentation is organized
SpinKube has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things.
- Installation guides cover how to install SpinKube on various platforms.
- Topic guides discuss key topics and concepts at a fairly high level and provide useful background information and explanation.
- Reference guides contain technical reference for APIs and other aspects of SpinKube’s machinery. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.
- Contributing guides show how to contribute to the SpinKube project.
- Miscellaneous guides cover topics that don’t fit neatly into either of the above categories.
Installation
Before you can use SpinKube, you’ll need to get it installed. We have several complete installation guides that covers all the possibilities; these guides will guide you through the process of installing SpinKube on your Kubernetes cluster.
Using SpinKube
Introductions to all the key parts of SpinKube you’ll need to know.
API Reference
Technical references for APIs and other aspects of SpinKube’s machinery.
Miscellaneous
Documentation that we can’t find a more organized place for. Like that drawer in your kitchen with the scissors, batteries, duct tape, and other junk.
Contributing
How to contribute to the SpinKube project.
Glossary
Glossary of terms used by the SpinKube project.
Feedback
Was this page helpful?
Glad to hear it!
Sorry to hear that. Please tell us how we can improve.