nytimes/library

Support an "archived" tag on folders and documents

Open

#194 opened on Jul 24, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (148 forks)auto 404
enhancementgood first issuegood for learning

Repository metrics

Stars
 (1,180 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem Description

As systems and workflows are deprecated, it is often useful to keep around old documentation around. I propose adding a way to "archive" documents similar to Github's archive feature to denote documents that may no longer be up to date, but could still be worth keeping for reference.

Feature

  • Adding a | archived tag to a document should put mark that page as archived. Adding an | archive tag to a folder will mark the folder as archived, as well as its home page and any nested folders and documents.
  • Archived documents will show with an archived badge somewhere on the page.

Stretch goals

  • Adjust search results to de-emphasize archived pages?

Contributor guide

Research direction
Examine how existing tags (like '|') are parsed in the codebase, then add an 'archived' tag handler that marks documents/folders and updates UI and search.
Tech stack
javascript
Domain
full stack
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60