Technical documentation for Armory Spinnaker
Clone or download
kevinawoo and ethanfrogers feat(install) add doc on how to handle halyard secrets (#367)
* feat(install) add doc on how to handle halyard secrets

* Update halyard_secrets.md
Latest commit 5a22c8b Oct 17, 2018
Permalink
Failed to load latest commit information.
_admin_guides Cant see server groups in kubernetes (#353) Sep 7, 2018
_assets/css Document new installer (#349) Sep 4, 2018
_glossary feat(toc) adds table of contents (#296) May 22, 2018
_includes Document new installer (#349) Sep 4, 2018
_install_guide ENG-2545 dinghy docs (#356) Sep 19, 2018
_layouts Fix footer install limk and added leadfeeder booster (#329) Jul 19, 2018
_overview Drodio 0716 (#327) Jul 17, 2018
_release_notes fix(releases) uploaded the wrong package (#354) Sep 11, 2018
_spinnaker feat(install) add doc on how to handle halyard secrets (#367) Oct 16, 2018
_user_guides ENG-2545 dinghy docs (#356) Sep 19, 2018
assets feat(spinnaker): Add description of rolling update with K8s (#364) Sep 28, 2018
bin cloudfront invalidation when its pushed (#219) Mar 22, 2018
images Document new installer (#349) Sep 4, 2018
.coafile adding coa file to help with grammar and spelling (#204) Feb 7, 2018
.editorconfig chore(editorconfig) add trailing new line (#355) Sep 11, 2018
.gitignore Update sprockets gem to fix security vulnerability (#338) Aug 21, 2018
Dockerfile feat(jekyll) version lock jekyll (#290) May 17, 2018
Gemfile Update sprockets gem to fix security vulnerability (#338) Aug 21, 2018
Gemfile.lock Update sprockets gem to fix security vulnerability (#338) Aug 21, 2018
Jenkinsfile Try er again Apr 18, 2017
README.md Video Tutorials (#238) Apr 4, 2018
_config.yml Document new installer (#349) Sep 4, 2018
admin_guides.md First iteration of design from Rob Apr 13, 2017
favicon.ico First iteration of design from Rob Apr 13, 2017
glossary.md Eng 212 (#57) May 30, 2017
index.md First iteration of design from Rob Apr 13, 2017
install-guide.md Merge all guides from 'Production Readiness' frame Sep 6, 2017
overview.md First iteration of design from Rob Apr 13, 2017
release-notes.md Fixed release notes & general archive layout styling. (#18) Apr 14, 2017
spinnaker.md Document new installer (#349) Sep 4, 2018
user-guides.md First iteration of design from Rob Apr 13, 2017

README.md

documentation

Technical documentation for Armory Spinnaker.

Development

Guides and docs are in markdown. They are split up into directories such as _overview, _user_guides, and _admin_guides. You can modify the markdown files in those directories, or add new ones. The 'order' field at the top of the md files determine where it will be placed on the list.

Jekyll is used to compile the markdown into a website.

Running locally

Once you have this repo checked out,

  1. Download and install Docker
  2. Start the server and make changes
    ./bin/run
    

You can view your changes at : http://localhost:4000 or http://192.168.99.100:4000 (if you're using docker-machine)

to exit, you can do ctrl+c

Pushing to prod

Make a pull-request and once its merged, Jenkins automatically puts it on S3.

Livereload

Install the Livereload chrome extension if you like seeing the page auto refresh when making a change.