Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salt-labs/docs
Documenting cloud-native things
https://github.com/salt-labs/docs
idem saltstack tanzu training unofficial vmware vra
Last synced: about 1 month ago
JSON representation
Documenting cloud-native things
- Host: GitHub
- URL: https://github.com/salt-labs/docs
- Owner: salt-labs
- License: other
- Created: 2023-02-14T22:41:02.000Z (almost 2 years ago)
- Default Branch: trunk
- Last Pushed: 2024-05-04T14:26:09.000Z (9 months ago)
- Last Synced: 2024-10-30T01:03:00.591Z (3 months ago)
- Topics: idem, saltstack, tanzu, training, unofficial, vmware, vra
- Language: HTML
- Homepage: https://docs.saltlabs.tech
- Size: 41.8 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docs
This repository contains the source files for the Salt Labs [docs](https://docs.saltlabs.tech) website.
## Overview
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.
## Content
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!_
## Development
Local development instructions for working with this repository.
- Ensure the submodules are up-to-date
```bash
# First time setup
git submodule update --init --recursive
# Future updates
git submodule update --recursive --remote
```
- Install the dependencies
```bash
npm install
go mod download -x
hugo mod clean
hugo mod tidy
hugo mod graph
```
- Run your own local instance using [hugo](https://gohugo.io)
```bash
hugo server --environment development
```
- Browse to the site running on `localhost`
```bash
open http://localhost:1313/
```
## Updating
- To update dependencies
```bash
# 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 graph
```
## CI
### GitHub Actions
There is an included workflow for Cloudflare Workers that will deploy the site.
## Theme
The official documentation for this theme (GoDocs) can be found at [gethugothemes](https://docs.gethugothemes.com/godocs/)
### Weights
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 |