prestodb/presto

automate broken link reporting in markdown files

Open

#21810 opened on Jan 29, 2024

View on GitHub
 (5 comments) (2 reactions) (1 assignee)Java (15,558 stars) (5,240 forks)batch import
docsfeature requestgood first issue

Description

Broken or bad links in markdown files could be identified and reported using automation to improve the usability of the documentation.

Expected Behavior or Use Case

Broken links in markdown files are identified and reported in an automated way.

Presto Component, Service, or Connector

Documentation, and the wiki - markdown files in the Presto repo.

Possible Implementation

Perhaps the GitHub Action Baler – BAd Link reportER would be a good way to automate this process. This is merely a suggestion, I'm very open to other proposed solutions.

Example Screenshots (if appropriate):

Context

When I found the broken link in CONTRIBUTING.md and Presto Development Guidelines - see PR 21808 - I considered that finding broken links in the Presto repos could be automated. A quick search later and I'd found the GitHub Action Baler – BAd Link reportER.

Contributor guide

Tech stack
github actionsshell
Domain
documentationci cd
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub Actions basicsYAML syntaxshell scripting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the existing CONTRIBUTING.md file and the linked PR #21808 to understand broken link patterns. Investigate the Baler GitHub Action and its configuration options. Propose a workflow file (e.g., .github/workflows/broken link check.yml) that runs on pushes or schedules. Ensure the action outputs results as a comment or summary.