If a release archive is available in both .tar.gz and .zip format, only
show the .zip archive in the download list.
Signed-off-by: Tobias Schmidt <tobidt@gmail.com>
For unknown reasons the netlify pipeline ends up in a state where a git
worktree is not created after a fresh clone of the repository. The
previous implementation checked for the actual checked out working tree
and assumed the administrative git worktree files have to exist as well
in that case. This change explicitly verifies the existence of both path
structures and handles more cases of inconsistencies gracefully.
Signed-off-by: Tobias Schmidt <tobidt@gmail.com>
So far every prometheus/alertmanater/... release branch had to be
manually configured in the nanoc.yaml config file. With this change the
most recent release branches will be checked out automatically if a
corresponding semver tag exists.
As the Prometheus git repository includes several hundreds of megabytes
of vendored assets, the repository is cloned bare and all blobs are
filtered by default. Each version is then checked out in an individual
working tree and git's spare-chekcout feature is used to reduce the
checkout to the `docs/` folder. The git data is cached in
`tmp/repo_docs/` and will be recreated automatically if removed.
Signed-off-by: Tobias Schmidt <tobidt@gmail.com>
The generation of "Configuration" pages runs the config_linker.rb filter to add anchors to <placeholder> in code blocks. The generation of these anchors doesn't "slugify" the placeholder text, thus leading to anchors like <tls_config>. This is conflicting with the default anchors generated by the markdown compiler for the HTML headers, as well as the extra anchors injected by add_anchors.rb.
In this PR I'm uniforming the way anchors are generated, to always "slugify" the text, and have links within the configuration code blocks working correctly. After this change, the id in the TOC also matches with the one of non-"Configuration" pages, which is currently different due to side effects introduced by the current logic.
Fixes #1304 and #833.
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco.pracucci@spreaker.com>
* Update Ruby gems.
* Remove nanoc-cachebuster due to incompatibility.
* Add README item about GitHub auth to improve build reliability.
* Fix various required config changes for 4.0
Signed-off-by: Ben Kochie <superq@gmail.com>
With this commit it becomes possible to define additional data sources
for content pages. The content will be cloned from the specified
repository. Links in these pages will be normalized to work inside the
docs project. It's assumed the documentation pages include the standard
nanoc config options and set :title and optionall :sort_rank.
This adds a new download section to the page with list for all available
precompiled versions for officially maintained components. The release
information are fetched via the Github API and rendered as static list.
Currently only the latest release and the newest pre-release (if
available) are show. This could be extended later. In order to keep the
list usable besides the massive list of prebuilt binaries, a javascript
os/arch filter has been added, defaulting to popular versions.
The following changes have been made on the way:
* Ensure all pages have a footer.
* Remove duplicated jquery inclusion.
* Use CSS to define text case of jumbotron buttons.
* Add Download section to the header.
* Reduce Github link to just the logo to save space.
* Update Getting Started and Installing sections.
Things like question marks or parentheses don't play nicely in URLs in
many contexts. Replace all special characters with dashes, and also
ensure that anchors are unique within a page if there are headers with
identical texts.
This is based roughly on
http://clarkdave.net/2012/02/building-a-static-blog-with-nanoc/
with a lot of small modifications to make it fit the existing docs site.
Blog posts should be added as:
content/blog/YYYY-MM-DD-post-title.md
They need to state the title, kind, created_at, and author in the
frontmatter, e.g.:
---
title: "This is a blog post title"
created_at: 2015-04-22
kind: article
author: Julius Volz
---
