prometheus-community/monaco-promql

Documentation on hover

Open

#7 opened on May 1, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (8 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (PR metrics pending)

Description

This one seems to be pretty simple to implement. https://microsoft.github.io/monaco-editor/playground.html#extending-language-services-hover-provider-example

An MVP can be made with hardly defined documentation entries.

But ! a very nice to have would be if we have a prometheus documentation page or code reference that we could use to render the doc dynamic into the hover.

Contributor guide

Research direction
Implement a hover provider using Monaco's registerHoverProvider. Start with hardcoded documentation entries for common PromQL functions, then explore dynamic fetching from Prometheus documentation or code references.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Monaco editor basicsPromQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65