docs.brigade.sh

⚠️  If you're looking to browse the docs, you might prefer exploring the docs.brigade.sh.

📚  If you're looking to update the docs, you've come to the right place!

🏠  For edits to the main brigade.sh site, go here.

📢  For contributions to blog.brigade.sh go here.

Development

⚠️  If you're only looking to edit content, you can skip this section.

The site is a simple Hugo site built with some tweaks to the Techdoc theme.

⚠️  The contents of themes/hugo-theme-techdoc are a git submodule. Do not tweak the theme by modifying the contents of themes/hugo-theme-techdoc. Instead, copy files you wish to tweak to a parallel directory structure under the root of the repository and modify them there. Hugo will automatically favor such files when building the site.

After initially cloning this repository, be sure to run the following commands:

$ git submodule init
$ git submodule update

To run the website locally, you'll need to first install Hugo.

You can then run a local development server. This process will watch for changes and automatically refresh content, styles, etc.:

$ cd docs
$ hugo serve

Deployment

Changes are automatically deployed to Netlify when merged to the main branch.

Build logs can be found here.

How to Add or Edit Content

Content changes are created via pull requests.

If you're creating a new page, follow these steps:

1. Add a new markdown file to the content/ directory. The directory structure within the content/ directory describes the layout of the doc tree, so be sure to place your content in the right subdirectory. You may create a new subdirectory if applicable.

2. Add front matter to the file using this format:

   ---
   linkTitle: Optional title used in the doc tree, but NOT used as the page's heading
   title: The page's title/heading
   description: An optional byline
   section: Should match the name of the subdirectory the page is in
   weight: Numerical weight within the section; lower weights appear higher in the doc tree
   ---

   Example:

   ---
   linkTitle: Quickstart
   title: A Brigade Quickstart
   section: intro
   weight: 3
   ---
   

3. Add the content below the --- as markdown. The title MUST NOT be re-included as a header in the content.

4. Open a PR.