📖 This section contains the OSM Docs 🚢 Also the website config to generate docs.openservicemesh.io 🔗 Looking for the main OSM website? Visit osm-www
docs.openservicemesh.io is a static site. The documentation content needs to be located at content/docs/
.
To ensure the docs content renders correctly in the theme, each page will need to have front matter metadata. Example front matter:
---
title: "Docs Home"
linkTitle: "Home"
description: "OSM Docs Home"
weight: 1
type: docs
---
- inclusion of
type: docs
is important for the theme to properly index the site contents - the
linkTitle
attribute allows you to simplify the name as it appears in the left-side nav bar - ideally it should be short and clear - whereas the title can handle longform names for pages/documents.
- built with the Hugo static site generator
- custom theme uses Docsy as a base, with Bootstrap as the underlying css framework and some OSM custom sass
- deployed to Netlify via merges to main. (@flynnduism can grant additional access to account)
- metrics tracked via Google Analytics
- Hugo installation guide
- NPM packages are installed by running
yarn
. Install Yarn if you need to.
// install npm packages
yarn
// rebuild the site (to compile latest css/js)
hugo
// or serve the site for local dev
hugo serve
The site auto deploys the main branch via Netlify. Once pull requests are merged the changes will appear at docs.openservicemesh.io after a couple of minutes. Check the logs for details.
hugo serve
will run the site locally at localhost:1313