1
0
mirror of https://github.com/prometheus/docs.git synced 2026-02-07 03:44:55 +01:00
Commit Graph

22 Commits

Author SHA1 Message Date
Tobias Schmidt
ef4e611471 Automate repository docs inclusion (#1762)
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>
2020-10-14 20:04:54 +02:00
Julien Pivotto
bb54990aba Add 2.20 pre-release docs (#1693)
* Add 2.20 pre-release docs

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-07-17 11:40:24 +02:00
Julien Pivotto
7a82f0a0e7 Reduce build time (#1662)
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-09 17:09:32 +02:00
Ben Kochie
1c4d72e0a6 Upgrade to Nanoc 4.0
* 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>
2018-08-18 10:52:15 +02:00
Matthias Rampke
c9cc805d2e Fix governance design
Let the governance use the default layout (all markdown files default to
"docs").

Make the default layout use the right div classes so the CSS can take
hold.

Fix the `layout` declaration for Markdown documents that are not `kind:
article`. Declare the governance to use the "default" layout, not the
"docs" one. This is the minimal change to support the governance
document. The layout choice needs a refactoring, but how to do that
needs more thought.
2018-01-08 17:55:27 +00:00
Tobias Schmidt
4565a55edf Remove old github pages README.md 2017-11-08 10:59:13 +01:00
Tobias Schmidt
ae9d74811b Handle embedded images in repository docs 2017-11-07 22:23:41 +01:00
Tobias Schmidt
4c74a86178 ADd warning for outdated versioned content 2017-11-07 21:07:45 +01:00
Tobias Schmidt
e15b6142f7 Add Redirects 2017-11-07 19:38:52 +01:00
Tobias Schmidt
bd570947a5 Add repository documentation data source
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.
2017-10-26 14:03:59 +02:00
Tobias Schmidt
f9bca64885 Create links to placeholder definitions in config
This will create local links of all placeholders in config blocks to
their respective definitions.
2017-03-04 18:58:28 -04:00
Julius Volz
e40149e39f Add cachebusting fingerprints to asset files.
This is using http://avdgaag.github.io/nanoc-cachebuster/.

docs.css had to be moved out of /static because the static datasource
treats all files as binary, and thus no textual filters can be applied
(necessary for rewriting the jumbotron background image URL).

Fixes https://github.com/prometheus/docs/issues/369
2016-04-09 00:16:33 +02:00
Tobias Schmidt
4110cb88ac Add table of contents filter 2016-01-20 10:59:14 -05:00
Steve Durrheimer
df23f67b8c Provide RSS feed for blog posts 2015-06-02 21:57:11 +02:00
Julius Volz
7f008551b6 Fix docs menu titles and homepage jumbotron. 2015-05-18 15:30:19 +01:00
Julius Volz
e72685a224 Minor comment clarification about output README.md. 2015-05-06 10:12:25 +02:00
Seth W. Klein
e2599b3b60 Add README.md to make the generated repository point here.
Fixes prometheus/prometheus.github.io#2.
2015-05-05 11:39:27 -04:00
Julius Volz
8ab96295aa Add initial blog code.
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
    ---
2015-04-22 15:52:16 +02:00
Brian Brazil
8fd8845480 Copy template docs over from the wiki.
Add links to client code for the pushgateway.

Make getting started link on frontpage go to Getting started section.

Put exposition formats at the end of instrumenting, as it's the least relevant
to normal users.
2015-01-13 13:57:59 +00:00
Julius Volz
3c8ae940e8 Add header anchors. 2015-01-07 18:02:31 +01:00
Julius Volz
2ac7105c4c Complete site redesign and added non-doc pages. 2014-12-22 03:37:54 +01:00
Julius Volz
426fab7c20 Initial commit of the Prometheus docs site. 2014-12-19 16:09:50 +01:00