You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tomáš Karásek be35d10060 Mention Packet file_sd (#1390) 1 day ago
content Mention Packet file_sd (#1390) 1 day ago
layouts Update footer to comply with CNCF/LF trademarks (#1256) 6 months ago
lib Fixed anchor links in Configuration pages (#1382) 1 week ago
scripts Just one char typo (#1049) 1 year ago
snippets snippets/saved_replies.md: Add DCO legal reasoning 1 year ago
specs Fix beta release asset name parsing 2 years ago
static Add ForgeRock interview (#1369) 4 weeks ago
.editorconfig Fix spelling error and add newline at end of file 1 year ago
.gitignore Create vendored Ruby setup 1 year ago
.ruby-version Change Ruby version to 2.4.3 in .ruby-version (#1168) 10 months ago
CONTRIBUTING.md Add missing note regarding requiring DCO 1 year ago
Dockerfile Add Dockerfile 4 years ago
Gemfile Upgrade to Nanoc 4.0 11 months ago
Gemfile.lock Update gems 7 months ago
Guardfile Cross-platform gems for guard watches 3 years ago
LICENSE License cleanup 4 years ago
MAINTAINERS.md Replace AUTHORS.md by an updated MAINTAINERS.md (#659) 2 years ago
Makefile Create vendored Ruby setup 1 year ago
NOTICE Minor cleanup of copyright date 8 months ago
README.md Document Netlify deployments 5 months ago
Rules Upgrade to Nanoc 4.0 11 months ago
nanoc.yaml Enforce utf-8 encoding on data sources (#1383) 4 days ago
prometheus_rsa.enc Set up continuous deployment 4 years ago

README.md

Prometheus Documentation

This repository contains both the content and the static-site generator code for the Prometheus documentation site.

Contributing Changes

See CONTRIBUTING.md for general instructions for new Prometheus contributors.

The main documentation contents of this website are located in the content/docs directory.

Documentation concerning the Prometheus server is maintained in the Prometheus server repository and cloned into the website at build time.

As a guideline, please keep the documentation generally applicable and avoid use-case-specific changes.

Prerequisites

You need to have a working Ruby environment set up (including bundler) and then install the necessary gems:

cd docs
make bundle

Building

To generate the static site, run:

make build

The resulting static site will be stored in the output directory.

Optionally, you can use an API token to avoid rate limits on the API. You can get an API token from https://github.com/settings/tokens/new.

export GITHUB_AUTHENTICATION='-u user:token'

Development Server

To run a local server that displays the generated site, run:

# Rebuild the site whenever relevant files change:
make guard
# Start the local development server in a separate shell:
make serve

You should now be able to view the generated site at http://localhost:3000/.

Automatic Deployment

This site is automatically deployed using Netlify.

If you have the prerequisite access rights, you can view the Netlify settings here:

Changes to the master branch are deployed to the main site at https://prometheus.io.

Netlify also creates preview deploys for every pull request. To view these for a PR where all checks have passed:

  1. In the CI section of the PR, click on “Show all checks”.
  2. On the “deploy/netlify” entry, click on “Details” to view the preview site for the PR.

You may have to wait a while for the “deploy/netlify” check to appear after creating or updating the PR, even if the other checks have already passed.

License

Apache License 2.0, see LICENSE.