./docs directory is used as markdown source files using blackfriday to render Thanos website resources.
However the aim for those is to also have those
*.md files renderable and usable (including links) via GitHub.
To make that happen we use following rules and helpers that are listed here
Front Matter is essential on top of every markdown file if you want to link this file into any menu/submenu option. We use YAML formatting. This will render in GitHub as markdown just fine:
--- title: <titke> type: ... weight: <weight> menu: <where to link files in> # This also is refered in permalinks. ---
Aim is to match linking behavior in website being THE SAME as Github. This means:
slug: /<filename with extension>
website/hugo.yamlnew dir as key
Then everywhere use native markdown relative symbolic links if you want to reference some mardkown file from
[title](../ relative path to .md file )
Or absolute path to the project repository if you want to link to exact commit e.g:
[title](../ /Makefile )
Small post processing script adjusts link for Hugo rendering.
NOTE: Spaces matters so:
[xxx](../ link and
[xxx] (link will not work.
.Site.Menus are added as soon as some file has Front Matter with certain
menu the same as sub-directory the file is in. This will help to manage all docs.
Show new menu section in main page by changing
If your company is using Thanos in production, we’d love to showcase your company’s logo on our page. Add yourself in
website/data/sponsors.yml like so:
- name: My Awesome Company url: https://wwww.company.com logo: company.png
Copy your company’s logo in
website/static/logos, and make sure it follows these rules:
Every PR is building website and on success it shows the link to preview.
We use Netlify for hosting. We are using Open Source license (PRO). Thanks Netlify for this!
On every commit to
master netlify runs CI that invokes
make web (defined in netlify.toml))
NOTE: Check for status badge in README for build status on the page.