isholgueras/docs

Tugboat Docs

Welcome to Tugboat!

Tugboat is a system that builds a working preview of a website for any branch, tag, commit, or pull request in a git repository. It can automatically create these previews for pull requests by integrating with GitHub, GitLab, or Bitbucket git repositories.

This document aims to provide the information required to use Tugboat. It includes tutorials, examples, and references for all experience levels.

Contributing

This document is open-source, and is available on GitHub. If you have any suggestions or other feedback about this document, we are happy to hear it! Open a GitHub issue or email us at [email protected].

Theme

The Hugo Learn Theme is included in this repo as a git subtree. To update the theme, find the latest tag at https://github.com/matcornic/hugo-theme-learn/releases and run the following

export TAG=2.4.0
git subtree pull --prefix themes/hugo-theme-learn https://github.com/matcornic/hugo-theme-learn.git $TAG --squash

Redirects

Redirects for historic URLs are maintained in static/.htaccess. These can be tested using Smolder config file in test/smolder.yaml. The tests need to be run against a live instance, like a Tugboat preview.

cat test/smolder.yaml | docker run -i mcameron/smolder pr125-mcktkhcj8krhxo5oaa7emgv5gcnf5e5l.tugboatqa.com

License Information

This document is licensed as Creative Commons Attribution-NonCommercial-ShareAlike CC BY-NC-SA.

Everything not covered above is licensed under the MIT license.