1
0
mirror of https://github.com/prometheus/docs.git synced 2026-02-06 09:44:54 +01:00
Commit Graph

66 Commits

Author SHA1 Message Date
Bartlomiej Plotka
9f7eba92bd spec: Added OpenMetrics 1.0 spec reference. (#2590)
Fixes https://github.com/prometheus/OpenMetrics/issues/292

Signed-off-by: bwplotka <bwplotka@gmail.com>
2025-03-10 15:17:22 +00:00
Julien
60899b37d2 Update icons to use Tabler and apply the new Twitter logo. (#2527)
* Update icons to use Tabler and apply the new Twitter logo.

Switch to Tabler because Prometheus 3.0 uses it, and Font Awesome's
latest open-source version doesn't include all necessary icons.

Signed-off-by: Julien <roidelapluie@o11y.eu>

* Remove twitter

Signed-off-by: Julien <roidelapluie@o11y.eu>

---------

Signed-off-by: Julien <roidelapluie@o11y.eu>
2024-10-08 16:09:21 +02:00
Patrice Chalin
d2aa45f25b Drop UA script (#2235)
Signed-off-by: Patrice Chalin <chalin@cncf.io>

Signed-off-by: Patrice Chalin <chalin@cncf.io>
2022-11-11 15:14:30 +01:00
Patrice Chalin
8c1584fcc8 Switch to use of gtag.js library for analytics (#2207)
Signed-off-by: Patrice Chalin <pchalin@gmail.com>

Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2022-09-27 21:18:53 +02:00
Ben Kochie
21126f7ced Update bootstrap/nanoc (#1903)
Update to the latest nanoc and bootstrap 3.x
* Bump jquery to 3.6.0.
* Remove trailing newline in .ruby-version.

[0]: https://docs.netlify.com/configure-builds/manage-dependencies/#ruby

Signed-off-by: Ben Kochie <superq@gmail.com>
2021-03-13 13:29:20 +01:00
Dan Rice
dedd6ac530 Load all used weights and styles of the Open Sans font
Signed-off-by: Dan Rice <dan.rice@sparkmeter.io>
2021-03-03 18:13:22 -05:00
38elements
d671955e36 Add Twitter card (#1866)
Signed-off-by: 38elements <mh19820223@gmail.com>
2021-02-12 12:00:34 +01:00
Tobias Schmidt
9b2d3e4d32 Fix canonical page link
Signed-off-by: Tobias Schmidt <tobidt@gmail.com>
2020-10-15 21:55:39 +02:00
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
7386c209d2 Alertmanager 0.21 docs (#1675)
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2020-06-18 15:51:24 +02:00
Ganesh Vernekar
d4073d38ba Update docs for 2.19 (#1671)
Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in>
2020-06-12 21:05:15 +02:00
Julius Volz
1651818fc8 Add Algolia Docsearch (#1637)
* Add Algolia Docsearch

This adds a search box to the top of the document that uses Algolia's
Docsearch (https://docsearch.algolia.com/). Indexing settings for our site
are configured in:

https://github.com/algolia/docsearch-configs/blob/master/configs/prometheus.json

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add more general docsearch:include true/false attribute

Will switch to this after it is indexed in a day or so...

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2020-05-20 08:55:49 +02:00
Julius Volz
0d6c0a2e01 Add prometheus-version docsearch meta tag to pages (#1636)
* Add prometheus-version docsearch meta tag to pages

I hope this will cause the Aloglia indexing engine to add a
"prometheus-version" indexing facet to our pages, so that when adding
Algolia search to the site in a subsequent step (I can already test it
locally), we can use this to search only for pages that are either the
latest Prometheus version (otherwise we get 10x the same-looking
result), or have no Prometheus version at all (the doc pages outside of
the versioned Prometheus sub-tree). I need to explicitly add "none" as a
version for the non-versioned pages, as Algolia search doesn't allow
facet filtering on null / undefined values.

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Fix "unversioned" -> "none"

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2020-05-19 11:46:45 +02:00
Celeste Horgan
3625189bad [WIP]Add a training & support page (#1604)
* Add a training & support page

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Make small edits

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Remove approval wording

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Reword description of training

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Make training courses more neutrally worded

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Remove all marketing blurbs

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Remove requirements, more blurbs

Signed-off-by: Celeste Horgan <celeste@cncf.io>

* Add the button again!

Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-05-13 21:39:33 +02:00
Chris Aniszczyk
a22b6b3637 Update footer to comply with CNCF/LF trademarks (#1256)
https://www.linuxfoundation.org/trademark-usage

Signed-off-by: Chris Aniszczyk <caniszczyk@gmail.com>
2019-01-11 08:36:38 -08:00
Richard Hartmann
bfb6c04ad3 Minor update to copyright dates (#1198)
Signed-off-by: Richard Hartmann <richih@debian.org>
2018-10-22 13:26:17 +01:00
Julius Volz
9c6c46c3c3 Point out that docs are open source and can be edited (#1033)
* Point out that docs are open source and can be edited

Signed-off-by: Julius Volz <julius.volz@gmail.com>

* Add contribution clarifications to README.md, link to it

Signed-off-by: Julius Volz <julius.volz@gmail.com>
2018-05-29 21:07:24 +02:00
Matthias Rampke
40e71d07f8 Revert changes to the default layout
and instead make a new "page" layout for markdown-based pages. This
avoids changing the HTML based pages which are using the "default"
layout currently.
2018-01-08 18:50:56 +00: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
089d38254f Add canonical link from versioned documentation pages 2017-11-07 21:50:51 +01:00
Tobias Schmidt
8f76c471e2 Update font-awesome to v4.7.0 2017-10-26 14:03:59 +02:00
Callum Styan
b5e7fb9c2a update copyright year to pull from Date.today.year 2017-08-08 08:40:36 -07:00
Andy Woodard
26c37a30a8 meta description had a typo
Corrected the spelling of "efficient" in the meta description
2016-04-19 14:10:14 -05:00
Julius Volz
33c8ec5c49 More markup cleanups/fixes. 2016-04-16 18:56:57 +02:00
Tobias Schmidt
ffbdada173 Add download section
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.
2016-04-16 12:02:48 -04:00
Fabian Reinartz
803cb20bd6 Merge pull request #389 from prometheus/routing-tree-deux
Update routing tree location
2016-04-12 16:41:27 +02:00
Julius Volz
121fc00f94 Move GitHub star button to "Open Source" section. 2016-04-12 15:35:16 +02:00
stuart nelson
520fc5fafe Update routing tree location
Routing tree editor is now only available as a
link from within the configuration docs for
alertmanager.

Code changes:
- Routing tree CSS is now in a CSS file
- The label set input now draws the route when
"enter" is pressed
2016-04-12 11:06:00 +02:00
Julius Volz
d55a613e7a Improve overall website design.
- Thinner and more elegant fonts on landing page.
- Removed "Overview" menu item, shortened "Documentation" to "Docs".
- Replaced jumbotron logo+title with motivational text.
- Removed "View details" buttons on landing page, make features clickable
  instead.
- Introduced testimonial quote section on landing page.
- Introduced "Open Source" section on landing page.
- Refactored overall jumbotron layout/content.
- Removed PromCon 2016 button.
- Changed documentation font to smaller size.
- Adjusted header font sizes and weights.
- Made code blocks look cooler, with orange left border.
- Don't wrap long lines in code blocks.
- Harmonized background colors between pre, code, and toc.
- Aligned the navbar Prometheus logo with the docs menu.
2016-04-11 21:30:53 +02: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
Julius Volz
79b7d83615 Fix blog sidenav.
This got broken in https://github.com/prometheus/docs/pull/365
2016-04-04 02:38:34 +02:00
Tobias Schmidt
9434588256 Improve search engine result presentation
- best to keep title length under 55 characters
- descrioption should not be longer than 150-160 characters
2016-04-02 16:26:47 -04:00
Tobias Schmidt
e84fc14ee5 Merge pull request #365 from prometheus/hide-inactive-menus
Collapse inactive navigation menus
2016-04-02 13:42:11 -04:00
Tobias Schmidt
26063c1d0c Collapse inactive navigation menus
Use javascript to hide all inactive menu items and only show one active
menu item at a time.
2016-04-02 13:08:25 -04:00
Tobias Schmidt
d977c5f77f Set descriptive front page title
The title of the homepage is used in Google search results.
2016-04-02 01:16:34 -04:00
Tobias Schmidt
ce7b754f52 Clean up navigation helper 2016-03-29 21:03:43 -04:00
Julius Volz
3d2b2edbf7 Add GitHub star button to header. 2016-03-28 21:05:05 +02:00
Julius Volz
1458dea893 Add PromCon link to landing page jumbotron. 2016-03-23 00:20:13 +01:00
Tobias Schmidt
ccc3d97491 Rename navigation helper function to nav() 2016-01-19 22:15:18 -05:00
Julius Volz
2a19ec78b5 Bring SoundCloud mentions up to date with reality.
Prometheus is an independent project and some of the current SoundCloud
mentions serve more to confuse/make people insecure about using
Prometheus than they help. This adjusts the language and mentions a bit.
2015-08-24 14:39:30 +02:00
Julius Volz
6a582e5f1a Fix author names display in blog single-post view. 2015-06-02 22:48:48 +02:00
Steve Durrheimer
df23f67b8c Provide RSS feed for blog posts 2015-06-02 21:57:11 +02:00
Julius Volz
14d0873fb8 Fix author display in single-post blog view. 2015-06-01 21:32:23 +02:00
Fabian Reinartz
d842afb426 Set HTML title to current page's title 2015-05-17 00:50:41 +02:00
Brian Brazil
b4e19000b0 Add blog post with the various online posts we're aware of.
Exclude Boxever wrapup, as we're already listing all those posts.
2015-04-24 12:46:18 +01: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
Julius Volz
8518f500aa Fix docs nav clickability in narrow browser window.
This fixes https://github.com/prometheus/docs/issues/60.
2015-04-13 19:06:17 +02:00
Jarred Trainor
3f1e23a84b Use protocol-relative URL to load Google Fonts 2015-01-26 17:13:49 +01:00
Julius Volz
ec9537de1c More favicons and show full logo in favicon. 2015-01-26 12:49:24 +01:00
Julius Volz
1d6d22558a Fix broken links, avoid redirects, etc. 2015-01-26 03:32:41 +01:00