Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,26 @@ export default {
repo: "prometheus",
repoDocsDir: "docs",
slugPrefix: "prometheus",
versioning: "release-branches",
minNumVersions: 10,
},
{
owner: "prometheus",
repo: "alertmanager",
repoDocsDir: "docs",
slugPrefix: "alerting",
versioning: "release-branches",
minNumVersions: 8,
},
{
owner: "prometheus-community",
repo: "postgres_exporter",
repoDocsDir: "docs",
slugPrefix: "exporters/postgres",
versioning: "git-ref",
ref: "3d2ee4adba4ec98106b6ec45e59b12f5b49ef3a4",
allowMissingFrontmatter: true,
},
],

// Single pages to fetch from external repos (not versioned).
Expand Down
62 changes: 62 additions & 0 deletions docs/exporters/documenting-exporters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: Documenting exporters
sort_rank: 100
---

Exporter documentation should live in the exporter's own repository. This keeps
the docs close to the code and release process, while still making them
available on prometheus.io.

## Source layout

Put user-facing documentation in a top-level `docs/` directory in the exporter
repository:

```text
docs/
README.md
getting-started.md
configuration.md
```

Use `docs/README.md` as the index page. GitHub renders this file when browsing
the `docs/` directory, and prometheus.io publishes it as the exporter landing
page.

## Frontmatter

Every Markdown page must include frontmatter with a `title` and `sort_rank`:

```yaml
---
title: Getting started
sort_rank: 1
---
```

Use `nav_title` when the sidebar label should be shorter than the page title.
Use `hide_in_nav: true` only for pages that should be addressable directly but
not shown in the sidebar.

Keep the page's `# Heading` in the Markdown body. Unlike the Prometheus server
and Alertmanager docs, exporter docs are rendered on prometheus.io exactly as
they appear on GitHub, so the heading remains useful in both places.

## Links and assets

Use relative links with the `.md` extension when linking between pages in the
same exporter repository:

```markdown
See [configuration](configuration.md) for all flags and options.
```

Store images and other documentation assets under `docs/` next to the Markdown
files that reference them. Relative image links are copied and rewritten by the
website build.

## Releases

The website pulls exporter docs from the latest stable GitHub release tag. Docs
merged into an exporter repository appear on prometheus.io after the exporter
cuts a release containing those files.
24 changes: 24 additions & 0 deletions docs/exporters/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Exporters
sort_rank: 6
nav_icon: package
---

Exporters expose metrics from systems that cannot be instrumented directly with
Prometheus client libraries. The exporter documentation in this section is
maintained in each exporter's own repository and pulled into this website from
the latest stable release.

The broader catalog of available exporters and integrations is listed in
[Exporters and integrations](/docs/instrumenting/exporters/).

## Documented exporters

* [PostgreSQL exporter](/docs/exporters/postgres/) (coming from
[prometheus-community/postgres_exporter](https://github.com/prometheus-community/postgres_exporter))

## Adding exporter documentation

Exporter maintainers can add website documentation by adding a `docs/` directory
to the exporter repository and following the
[exporter documentation contract](/docs/exporters/documenting-exporters/).
2 changes: 1 addition & 1 deletion docs/instrumenting/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ wide variety of JVM-based applications, for example [Kafka](http://kafka.apache.
* [OpenTSDB Exporter](https://github.com/cloudflare/opentsdb_exporter)
* [Oracle DB Exporter](https://github.com/iamseth/oracledb_exporter)
* [PgBouncer exporter](https://github.com/prometheus-community/pgbouncer_exporter)
* [PostgreSQL exporter](https://github.com/prometheus-community/postgres_exporter)
* [PostgreSQL exporter](/docs/exporters/postgres/) ([source](https://github.com/prometheus-community/postgres_exporter))
* [Presto exporter](https://github.com/yahoojapan/presto_exporter)
* [ProxySQL exporter](https://github.com/percona/proxysql_exporter)
* [RavenDB exporter](https://github.com/marcinbudny/ravendb_exporter)
Expand Down
Loading
Loading