GitHub - spinnaker/spinnaker.github.io: spinnaker documentation site · GitHub Skip to content Navigation Menu Sign in Appearance settings * Platform * AI CODE CREATION * GitHub Copilot Write better code with AI * GitHub Copilot app Direct agents from issue to merge * MCP Registry Integrate external tools * DEVELOPER WORKFLOWS * Actions Automate any workflow * Codespaces Instant dev environments * Issues Plan and track work * Code Review Manage code changes * Code Quality Enforce quality at merge * APPLICATION SECURITY * GitHub Advanced Security Find and fix vulnerabilities * Code security Secure your code as you build * Secret protection Stop leaks before they start * EXPLORE * Why GitHub * Documentation * Blog * Changelog * Marketplace View all features * Solutions * BY COMPANY SIZE * Enterprises * Small and medium teams * Startups * Nonprofits * BY USE CASE * App Modernization * DevSecOps * DevOps * CI/CD * View all use cases * BY INDUSTRY * Healthcare * Financial services * Manufacturing * Government * View all industries View all solutions * Resources * EXPLORE BY TOPIC * AI * Software Development * DevOps * Security * View all topics * EXPLORE BY TYPE * Customer stories * Events & webinars * Ebooks & reports * Business insights * GitHub Skills * SUPPORT & SERVICES * Documentation * Customer support * Community forum * Trust center * Partners View all resources * Open Source * COMMUNITY * GitHub Sponsors Fund open source developers * PROGRAMS * Security Lab * Maintainer Community * GitHub Stars * Archive Program * REPOSITORIES * Topics * Trending * Collections * Enterprise * ENTERPRISE SOLUTIONS * Enterprise platform AI-powered developer platform * AVAILABLE ADD-ONS * GitHub Advanced Security Enterprise-grade security features * Copilot for Business Enterprise-grade AI features * Premium Support Enterprise-grade 24/7 support * Pricing Search / Sign in Sign up Appearance settings You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Uh oh! There was an error while loading. Please reload this page . This repository was archived by the owner on Jul 10, 2021. It is now read-only. spinnaker / spinnaker.github.io Public archive * Notifications You must be signed in to change notification settings * Fork 385 * Star 77 * Code * Issues 22 * Pull requests 33 * Actions * Projects * Security and quality 0 * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security and quality * Insights master Branches Tags Go to file Code Open more actions menu Latest commit   History 2,040 Commits 2,040 Commits Folders and files Name Name Last commit message Last commit date .github/ workflows .github/ workflows     _api_templates _api_templates     _changelogs _changelogs     _data _data     _includes _includes     _layouts _layouts     _pages _pages     _sass _sass     assets assets     community community     concepts concepts     downloads downloads     guides guides     news news     reference reference     setup setup     success-stories success-stories     .dockerignore .dockerignore     .gitignore .gitignore     .mergify.yml .mergify.yml     .ruby-version .ruby-version     CNAME CNAME     Dockerfile Dockerfile     Gemfile Gemfile     Gemfile.lock Gemfile.lock     LICENSE.txt LICENSE.txt     README.md README.md     Rakefile Rakefile     _config.yml _config.yml     banner.js banner.js     favicon.ico favicon.ico     index.md index.md     minimal-mistakes-jekyll.gemspec minimal-mistakes-jekyll.gemspec     package.json package.json     View all files Repository files navigation * * README * Code of conduct * Contributing * MIT license * Security More items THIS REPOSITORY IS NO LONGER USED TO GENERATE THE SPINNAKER.IO WEBSITE. All pull requests should be made in the new github.com/spinnaker/spinnaker.io repo. --------------------------------- ARCHIVED ------------------------------ Local preview The easiest way to preview and test your changes to Spinnaker.io is to run your branch locally with Docker, via the dockerfile included in the root directory. In the root directory of your fork, run: docker build --tag spinnaker/spinnaker.github.io-test . docker run -it --rm --mount " type=bind,source= $( pwd ) ,target=/code " \ -p 4000:4000 spinnaker/spinnaker.github.io-test --incremental Navigate to http://localhost:4000 to see your locally generated page. Jekyll method Alternatively, set up Jekyll and use it to run the site locally. It runs on Ruby, and running multiple versions of Ruby on a single system can create challenges. These instructions install rbenv , which makes it easy to install and switch to a specific Ruby version. Installation * (Optional) Create and run from a fresh VM instance, and forward the Jekyll default port (4000): * gcloud compute instances create jekyll --image-project=ubuntu-os-cloud --image-family=ubuntu-1804-lts --machine-type=n1-standard-1 * gcloud compute ssh jekyll --ssh-flag="-L 4000:localhost:4000" * Install rbenv and ruby-build . Add these to $PATH : sudo apt update sudo apt-get install -y git bzip2 build-essential libssl-dev libreadline-dev zlib1g-dev git clone https://github.com/rbenv/rbenv.git ~/.rbenv git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc echo 'eval "$(rbenv init -)"' >> ~/.bashrc source ~/.bashrc * Install and use ruby 2.4.1 rbenv install 2.4.1 rbenv global 2.4.1 * Fork and clone your forked repo: GITHUB_USER=$USER # or something else here git clone https://github.com/$GITHUB_USER/spinnaker.github.io.git * Install bundle gem cd spinnaker.github.io gem install bundler bundle install Your system is now ready for local preview of the documentation site. Local preview * Start Jekyll server * bundle exec jekyll serve --watch * (Optional): Add --incremental to speed up page generation when working on one page * bundle exec jekyll serve --watch --incremental * Navigate to http://localhost:4000 to see your locally generated page. (Optional) Host the website on Amazon S3 Hosting the documentation website on Amazon S3 allows review from look/feel perspective before a pull request is submitted. This allows peer reviews of a breaking change without needing any technical setup by the reviewer. * Enable static website hosting on a S3 Bucket * gem install s3_website * s3_website cfg create * Delete s3_id and s3_secret so that your AWS credentials can be read from ~/.aws/credentials * Modify url property at _config.yml to use the CNAME that you want to use * jekyll build * s3_website push Page Generation A page named foo.md will be transformed to foo/index.html and links to foo will result in an HTTP 301 to foo/ . This has two implications: * It is more efficient to include the trailing / in links. * If you anticipate including resources like images or subpages, create foo/index.md instead of foo.md . During local development, see what's actually generated by browsing the _site directory. Mermaid Sequence diagrams can be generated with the mermaid.js library by adding {% include mermaid %} near the bottom of the page. See some of the security docs for an example. Breadcrumbs Each page has a breadcrumb trail at the top that is based on the URL structure. You should ensure that there is at least an index.md file within each URL directory, otherwise the links will break. Link Checker Keep the "broken window theory" at bay by ensuring all links work with HTML Proofer Run link checker before committing: rake test About spinnaker documentation site Topics hacktoberfest Resources Readme MIT license Code of conduct Code of conduct Contributing Contributing Security policy Security policy Activity Custom properties Stars 77 stars Watchers 16 watching Forks 385 forks Report repository Releases Packages Used by Contributors Languages Footer (c) 2026 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Community * Docs * Contact * Manage cookies * Do not share my personal information You can’t perform that action at this time.