Spinnaker Summit 2022 keynotes and talks now available!

Browse Playlist
Spinnaker Logo Horizontal
  • Docs
  • Community
  • Success Stories
  • Blog
  • Versions
  • GitHub
  • Documentation
      • Concepts
          • Clusters
          • Pipelines
          • Providers
          • Spinnaker eBook
      • Setup
        • Quickstart
          • Install
            • Install Halyard
              • Choose Cloud Providers
                  • AWS
                    • Amazon EC2 Amazon ECS AWS Concepts
                  • Kubernetes
                    • Alibaba K8s EKS GKE K8s Provider Oracle K8s
                  Azure Cloud Foundry DC/OS Docker Registry Google App Engine Google Compute Engine Kubernetes (legacy provider) Oracle
              Choose your Environment
              • External Storage
                • External Storage Overview Amazon S3 Azure Storage Google Cloud Storage Minio Oracle Object Storage Redis
              Deploy Spinnaker and Connect to the UI Back Up Your Config Halyard FAQ Configuration Upgrading
          • Configure Everything Else
              • Server Group Launch Settings
                  • AWS EC2 Server Group Launch Settings
                    • AWS EC2 Launch Templates Setup AWS EC2 Launch Templates
              • Configure Artifacts
                • Configure a Git Repo Artifact Account Configure a GitHub artifact account Configure a GitLab artifact account Configure Bitbucket Artifact Credentials Configure Helm Artifact account Configure HTTP Artifact Credentials Configure Maven Artifact Credentials Configure S3 Artifact Configuring GCS Artifact Credentials Configuring Oracle Object Storage Artifact Credentials
              • Bakery
                • Google Compute Engine Oracle Cloud Infrastructure
              • Security
                  • Authorization (RBAC)
                    • Google Groups with G Suite LDAP Pipeline Permissions SAML Service Accounts GitHub Teams
                  Administrator functionality
                  • Authentication
                    • LDAP
                      • OAuth 2.0
                        • Azure G Suite GitHub Organizations OAuth 2.0 Configuration Oracle Cloud
                      SAML 2.0 X.509 Client Certificates
                  SSL
              • Set Up Triggers
                  • Configuring GitHub Webhooks
                  Amazon AWS Pub/Sub Google Cloud Pub/Sub
              Install Spin CLI
              • CI
                • AWS CodeBuild Fiat Permissions Google Cloud Build Jenkins Travis CI Wercker
              • Logging
              • Monitoring
              Canary
              • Additional Features
                • Configuring the Script Stage Enable Slack Support Channels Notifications and Events Guide User Data Files and Metadata
              Clouddriver Account Management External Account Configuration
          • Productionize Spinnaker
              • Configure Caching
                • Configure Spinnaker's Usage of Redis Externalize Redis
              • Configure Scaling
                • Horizontally Scale Spinnaker Services
              • Persistence
                • Set up Clouddriver to use SQL Set up Front50 to use SQL Set up Orca to use SQL
      • Guides
          • Development Guides
              • Extending Spinnaker
                • Integrate your CI Kubernetes CRD Extensions Writing a New Stage
              • Plugin Creator Guide
                • Backend Service Extension Points Frontend Plugin Development Plugin Compatibility Testing Plugin Project Configuration Test a Pipeline Stage Plugin
          • Operator Guides
            • Custom CAs for Webhooks Custom Job Stages Custom Webhook Stages Deploy Custom Spinnaker Builds Echo: Cassandra to In-Memory Front50: Cassandra to Object Store Front50: Cassandra to Redis Hiding Stages Orca: Redis to SQL
          • Runbooks
            • API Rate Limiting Caching: Account Name Based Sharding Orca: QoS Orca: Zombie Executions Sharding Spinnaker
          • spin CLI Guide
            • Manage Apps Manage Canary Manage Pipeline Templates Manage Pipelines
          • Tutorials
              • Codelabs
                • Online Codelabs App Engine: Source to Prod Azure VM Scale Sets: Source to Prod Bake and Deploy Pipeline CD to K8s on Oracle Continuous Delivery to Kubernetes on Azure DC/OS: Source to Prod Deploy Artifacts from Artifactory to CF Deploy GCS Pub/Sub Artifacts to App Engine Deploy GCS Pub/Sub Artifacts to CF GCE Source To Prod Intro: Hello Deployment K8s Source to Prod OCI Source to Prod Safe Deployments
              Videos
          • User Guides
            • Get Started
              • Application User Guide
                • Configure an application Create an application Delete an application
              • Canary Analysis
                • Canary Overview
                  • Best practices
                  • Canary judgment
                  • Config
                    • Configure a canary Filter templates
                  • Canary stage
              • General Purpose Tagging Guide
              • Instance Links
              • Kubernetes
                • Annotation-Driven UI Automated Rollbacks Best Practices Deploy Helm Charts Deploy Kubernetes Manifests Manage Traffic Parameterize Kubernetes Manifests Patch Kubernetes Manifests Rollout Strategies Run Job (Manifest) Use Kustomize for Manifests
              • Managed Delivery
                • Overview Getting Started API Artifacts Delivery Configs Env Constraints Git-Based Workflows Mark an Artifact as Bad Pin an Environment Resource Status FAQ CI Features
              • Pipeline User Guide
                  • Managing Pipelines
                  • Pipeline Expressions Guide
                  • Using Pipeline Templates
                    • Enable Pipeline Templates Create a Pipeline Template Inherit from a Template Create a Pipeline from a Template Visualize a Hydrated Pipeline
                  • Triggers Overview
                    • Bitbucket
                      • GCS
                      • GitHub
                      • Jenkins
                      • JFrog Artifactory
                      • Pub/Sub Messages
                      • Webhooks
                  • Search for Triggered Pipeline Executions
              • Plugin User Guide
                • Plugin Deployment Example
      • Reference
          • Architecture
            • Overview
              • Authentication & Authorization
                • Authentication Architecture Authorization Architecture
              Life of a Bake Life of a Deployment
          • API
              • Service APIs
                  • Orca
              Swagger UI
          • Halyard
            • Commands Component Sizing Custom Settings High Availability
              • Secrets
                • Secrets in GCS Secrets in Google Secret Manager Secrets in S3
          Monitoring
          • Providers
            • Amazon ECS Amazon Web Services Azure Cloud Foundry Google App Engine Google Compute Engine Kubernetes (Legacy) Kubernetes Provider Oracle Cloud
          • Spinnaker Artifacts
            • Artifacts from Build Triggers Artifacts In App Engine Artifacts In Cloud Foundry Artifacts In Kubernetes
              • In Pipelines
              • Types of Artifacts
                • Bitbucket File Docker Image Embedded Base64 GCS Object Git Repo GitHub File GitLab File HTTP File Kubernetes Object Maven Artifact Oracle Object S3 Object
          • Spinnaker Artifacts - Legacy UI
            • Artifacts from Build Triggers Artifacts In App Engine (Legacy) Artifacts In Kubernetes (Legacy) Artifacts In Pipelines (Legacy)
              • Types of Artifacts
                • Bitbucket File Docker Image Embedded base64 GCS Object Git Repo GitHub File Gitlab File HTTP File Kubernetes Object Oracle Object S3 Object
          • Spinnaker Pipeline Reference
              • Pipeline Expressions
              • Pipeline Stages
              • Pipeline Templates
      • Community
          • Contributing
              • Code
                • Build Statuses Nightly Builds Releasing A Patch Code Languages, Libraries, and Conventions
                  • Developer How Tos
                      • Dev Env
                        • Getting Set Up Kork Library
                          • Provider Setups
                            • Dev on AWS
                      • Service Overviews
                        • Orca Internals
                      • Extending Spinnaker
                        • Kubernetes CRD Extensions Writing a New Stage
                      • Plugin Creators
                        • Plugin Creators Overview Plugin Project Config Stage Plugin Details
                  Managing Deprecations Pull Requests and Changes
              • Docs
                • Documentation Style Guide Make a Change Using a Local Clone Make a Change Using the GitHub Web UI Reviewing Pull Requests
              Getting Started as a Content Contributor Code Of Conduct
          • Get Help
              • FAQ
              • Governance
                • Spinnaker Special Interest Groups
          • Stay Informed
              • Security
              • Usage Statistics
              Captain's Log: The State of Spinnaker
              • News
                  • Newsletter
                    • Flying Edition 1 Flying Edition 2 Flying Edition 3
                  • Videos
          • Security
          • Google Summer of Code
            • try.spinnaker.io
      • Releases
        • Next Release Preview Patching Changelogs Release Cadence Release Manager Roadmap Support Policy Versions
Edit this page Create documentation issue Create project issue
  1. Documentation
  2. Community
  3. Contributing
  4. Docs

Docs

Guides for contributing to the Spinnaker documentation.

Documentation Style Guide

Make a Change Using a Local Clone

Make a Change Using the GitHub Web UI

Reviewing Pull Requests

Last modified July 13, 2021: docs(site): add 404.html and fix docs contrib section (#117) (df60766)

CD Foundation logo Deploys by Netlify
© 2023 Copyright © 2020 The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page. Linux is a registered trademark of Linus Torvalds. All Rights Reserved
Privacy Policy | Terms of Use