ietf-tools / ietf-tools/queue

Cluster legend: use descriptive text instead of diagram

Open Beginner friendly
#111 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
1
Forks
3
Avg merge
1d 8h
Merged PRs (30d)
8

Description

Use the following text description as the legend instead of the diagram.

  • Blue - doc is In Progress and can move on its own through the queue (i.e., does not have a normative reference to an I-D)
  • Green - doc is In Progress because its normative reference is in the queue
  • Pink - doc is blocked because its normative reference is not in the queue (a state previously known as MISSREF)
  • Orange - a referenced doc that is not in the queue. This doc needs to be in the queue for blocked docs in the cluster to move.

I've received user feedback that the above text is easier to understand than the diagram.

h/t @evyncke @debcooley

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 locating the cluster legend and its current diagram in the TypeScript frontend. Replace the diagram with the supplied four-item color description, then verify that the legend clearly explains each status and referenced-document state.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.