Giter Club home page Giter Club logo

docs's Introduction

Docs

This repository contains the source files for the Salt Labs docs 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!

Contributions

Development

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/

Updating

  • 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 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

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

docs's People

Contributors

dependabot[bot] avatar mahdtech avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.