Skip to content

Need a clear way to test the documentation #340

@tartkri-bot

Description

@tartkri-bot

Problem

The current documentation describes testing using the PMM Docker image, but this approach does not work reliably for everyone.

Expected

We need a new, documented way to test the documentation that works consistently for all contributors.

Current State

  • Testing via PMM Docker image is described but fails
  • Contributors cannot verify their doc changes locally

Suggested Solutions

  • Document a working local testing method
  • Consider alternatives like MkDocs, Hugo, or other static site generators
  • Provide clear step-by-step instructions

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Shipped

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions