https://github.com/trussworks/trussels-guide

https://github.com/trussworks/trussels-guide

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/trussworks/trussels-guide
• Owner: trussworks
• Created: 2019-11-25T21:51:47.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T19:44:13.000Z (7 months ago)
• Last Synced: 2024-04-08T22:28:32.115Z (7 months ago)
• Language: SCSS
• Homepage: https://guide.truss.works
• Size: 304 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• jimsghstars - trussworks/trussels-guide - (SCSS)

README

        
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/trussworks/trussels-guide/main.svg)](https://results.pre-commit.ci/latest/github/trussworks/trussels-guide/main)

# trussels-guide

The source for [guide.truss.works](https://guide.truss.works).

## How to make a change

The Trussel's Guide is important documentation and needs to be correct. Anybody from Truss should feel free to submit a pull request to change the guide. We use the `CODEOWNERS` file to keep track of who should review and merge PRs.

## Architecture

The guide is hosted on Github Pages. DNS is managed via the Truss AWS account. Merges to `main` deploy in a couple of minutes.

Github Pages acts like Jekyll, more or less.

## Local testing

The following methods will result in the site being available at [http://localhost:4000](http://localhost:4000). However, for small changes, it's easier to use Github's web editor.

### Local Ruby

If you have `asdf` configured , you can run the following:

```sh

asdf install

bundle install

bundle exec jekyll serve

```

### Troubleshooting

If our dependencies become out of date, you'll need to update them. Here's an example where the version of `octokit` we were using was no longer available:

```

$ bundle install

Fetching gem metadata from http://rubygems.org/...........

Your bundle is locked to octokit (4.17.0), but that version could not be found in any of the sources listed in your Gemfile.

```

In this case, you'll need to update the dependency:

```sh

bundle update octokit

```