prestodb/presto

automate broken link reporting in markdown files

Open

#21.810 aperta il 29 gen 2024

Vedi su GitHub
 (5 commenti) (2 reazioni) (1 assegnatario)Java (5240 fork)batch import
docsfeature requestgood first issue

Metriche repository

Star
 (15.558 star)
Metriche merge PR
 (Merge medio 34g 14h) (120 PR mergiate in 30 g)

Descrizione

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.

Guida contributor