docs

README

Overview

This is the repo for Armory documentation site. We welcome contributions from people outside of Armory.

The site is hosted by Netlify, which generates a preview build for every pull request. Install the extended version of Hugo (brew install hugo) if you want to compile and run the project locally. The Hugo extended version (currently 0.110.10) is specified in both config.yaml and netlify.toml. Armory docs uses the Docsy theme as a Go module. If you want to build locally, you should make sure your workstation has the required software installed. https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/

The latest version of the docs website is the master branch. Previous releases point to branches that start with v.

The site has built-in support for Mermaid, which is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). So less time needs to be spent on documenting, as a separate and laborious task. Even non-programmers can create diagrams through the Mermaid Live Editor.

Mermaid resources:

• Quick Start
• Tutorials
• Mermaid Live Editor - create your diagrams visually and copy the generated Mermaid code to your page

The theme also supports PlantUML and draw.io.

Cloning the project

Contributor's Guide

People who are not part of the Armory organization need to create a fork of this repo. See the GitHub.com help docs for how to fork a repo.

Clone your forked repo:

git clone git@github.com:<github-username>/docs.git

Set this docs repo as the upstream remote:

git remote add upstream https://github.com/armory/docs.git

Confirm your origin and upstream repositories:

git remote -v

Output is similar to:

origin	git@github.com:<github-username>/docs.git (fetch)
origin	git@github.com:<github-username>/docs.git (push)
upstream	https://github.com/armory/docs.git (fetch)
upstream	https://github.com/armory/docs.git (push)

Update your local repository

Make sure your local repository is current before you start making changes. Fetch commits from your fork's origin/master and spinnaker/spinnaker.github.io's upstream/master:

git fetch origin
git fetch upstream

Create a working branch

Make sure you are in your master branch before you create your working branch. You can use git branch to see which branch you are in.

git branch

The output lists your local branches. There is an * next to the branch you are in.

working-branch-1
working-branch-2
* master

If you are not in master, execute git checkout master to go to your master branch. See the Understanding history: What is a branch? section of the Git User Manual for more information.

Create a new working branch based on upstream/master.

git checkout -b <your-working-branch> upstream/master

Since git tracks changes to upstream\master, you don't need to rebase your fork before you create a working branch.

Content is in content/en/docs. Make your changes to the desired file.

Use the git status command at any time to see what files you've changed.

If you have installed Hugo and want to preview your changes locally, run from the repo root:

hugo server

Commit your changes

Check which files you need to commit:

git status

Output is similar to:

On branch <your-working-branch>
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)

modified:   content/en/docs/spinnaker/armory-halyard.md

no changes added to commit (use "git add" and/or "git commit -a")

Create a commit:

git commit -a -m "<your-commit-subject>" -m "<your-commit-description>"

• -a: Commit all staged changes.
• -m: Use the given <your-commit-subject> as the commit message. If multiple -m options are given, their values are concatenated as separate paragraphs.

Your commit messages must be 50 characters or less. Do not use any GitHub Keywords in your commit message. You can add those to the pull request description later.

Push your working branch and its new commit to your remote fork:

git push origin <your-working-branch>

You can commit and push many times before you create your PR.

Create your pull request

See the GitHub docs for how to create a pull request from a fork.

On user-owned forks, select Allow edits from maintainers so maintainers can make changes to your pull request,

Monitoring

The Armory documentation uses New Relic to monitor the website status and other metrics.