eclipse-xtext / eclipse-xtext/xtext

Automate invalid hyperlink detection on the Xtext/Xtend website

Open
#1,753 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

releng
Dominant language
Java
Stars
831
Forks
330
Avg merge
3d 7h
Merged PRs (30d)
12

Description

It would be useful to integrate invalid hyperlink detection on the build process, e.g using the Jekyll html-proofer plugin. I executed it locally on the Xtext Community website and got the following report:

screenshot

It seems that currently it reports some false positive results.

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 Xtext Community website and its build process, then reproduce the reported results with the Jekyll html-proofer plugin. Identify which reported failures are false positives and determine how automated hyperlink detection should run in the build; done means the check is integrated and the known false positives are handled.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
build-system, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.