Prometheus-operator: Host the documentation on a public-facing website

Created on 21 Aug 2020  路  3Comments  路  Source: prometheus-operator/prometheus-operator

What is missing?

Question: do we want more easily browsable docs? Or is the goal to just point users here: https://github.com/prometheus-operator/prometheus-operator/tree/master/Documentation

Why do we need it?

This message at https://coreos.com/operators/prometheus/docs/latest/

These docs are deprecated while they are being migrated to Red Hat. For the most up to date docs, please see the corresponding GitHub repository.

Environment

  • Prometheus Operator version:

    all

Anything else we need to know?:

Context is linking to docs from the helm chart (rename in progress. See https://github.com/scottrigby/prometheus-helm-charts/pull/1)

kinfeature

Most helpful comment

I've changed the title of the issue so it doesn't mandate GitHub pages anymore.

All 3 comments

We definitely want to have a better and searchable documentation. A first prerequisite was migrating the project from the coreos organization to its own organization. This is now complete but I don't think that anybody has started anything yet for the docs. Contributions welcome!

I am not a fan of github pages and would prefer to do it with netlify, but I agree we should have a documentation site.

I've changed the title of the issue so it doesn't mandate GitHub pages anymore.

Was this page helpful?
0 / 5 - 0 ratings