This repository contains the source files for the Salt Labs docs website.
In the spirit of open collaboration, we're sharing some non-sensitive Cloud Native Engineering resources that we found useful here at Salt Labs in our travels.
So what can and can't we put here?
| Example | YES / NO |
|---|---|
| Customer information | NO ❌ |
| Project information | NO ❌ |
| Internet Links | YES ✅ |
| Publicly available information with references | YES ✅ |
Do you have good resources to share?
Contributions are welcome!
Local development instructions for working with this repository.
- Ensure the submodules are up-to-date
# First time setup
git submodule update --init --recursive
# Future updates
git submodule update --recursive --remote- Install the dependencies
npm install
go mod download -x
hugo mod clean
hugo mod tidy
hugo mod graph- Run your own local instance using hugo
hugo server --environment development- Browse to the site running on
localhost
open http://localhost:1313/- To update dependencies
# Update development dependencies
npm update --save-dev
# Test...
# Update production dependencies
npm update --save-prod
# Update Workers dependencies
npm --prefix workers-site update --save-dev
npm --prefix workers-site update --save-prod
# update Go
hugo mod clean
hugo mod get -u
hugo mod tidy
hugo mod graphThere is an included workflow for Cloudflare Workers that will deploy the site.
The official documentation for this theme (GoDocs) can be found at gethugothemes
The weights are used to determine the order of the pages in the menu. The lower the weight, the higher the page will appear in the menu.
It can get a little confusing, so here's a table to track the weights.
| Page Name | Weight |
|---|---|
| Changelog | 1 |
| Contact | 1 |
| FAQ | 1 |
| Introduction | 1 |
| Search | 1 |
| Frameworks | 1000-1999 |
| Technologies | 2000-2999 |
| Tutorials | 3000-3999 |