jaegertracing / jaegertracing/documentation

Refresh documentation for Frontend/UI configuration

Open
#489 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
84
Forks
192
Avg merge
12h 25m
Merged PRs (30d)
4

Description

## Requirement - what kind of business use case are you trying to solve?

No documentation for a JS file format to configure jaeger's UI

## Problem - what in Jaeger blocks you from solving the requirement?

There is no information about existing(https://github.com/jaegertracing/jaeger-ui/issues/123) functionality that describe how to use JS config file instead of JSON

## Proposal - what do you suggest to solve the problem or improve the existing situation?

Update documentation

## Any open questions to address

https://groups.google.com/g/jaeger-tracing/c/Ouyo2x27bYg/m/x5jR9wAhBgAJ

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Jaeger UI configuration functionality described in jaegertracing/jaeger-ui#123 and the linked forum discussion. Locate the documentation section covering UI configuration and document how to use a JavaScript configuration file instead of JSON. Done means the supported format and usage are clearly explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.