search

jakartaee / mail-api

Jakarta Mail Specification project
https://jakartaee.github.io/mail-api
Other
240 stars 100 forks source link

URLs no longer clickable on CONTRIBUTING page when viewed through GitHub Pages #721

Open aakoch opened 3 months ago

aakoch commented 3 months ago

Tiny documentation issue. I almost feel bad about reporting this.

Describe the bug Commit https://github.com/jakartaee/mail-api/commit/0b79585cf2be9ec2a923c2e5c05fb5b1d01bd2c5 removed the Markdown needed to make the links clickable on the GitHub Pages version of Markdown files and the page is slightly harder to navigate.

When viewing the page here, the links are not "autolinked": https://jakartaee.github.io/mail-api/CONTRIBUTING

But when viewing the page here, the links are "autolinked": https://github.com/jakartaee/mail-api/blob/master/CONTRIBUTING.md

To Reproduce Steps to reproduce the behavior:

  1. Go to https://jakartaee.github.io/mail-api/CONTRIBUTING
  2. Links to URLs, such as https://projects.eclipse.org/projects/ee4j.mail are no longer converted to hyperlink tags ().
  3. Compare to https://web.archive.org/web/20201129013940/https://eclipse-ee4j.github.io/mail/CONTRIBUTING.html where the URLs were links.

Expected behavior Developer resource URLs to be easily navigated to.

Additional context The discrepancy comes the jekyll-build-pages action to deploy the site to GitHub pages doesn't autolink. It doesn't look like that is an option either. If that, or some other deploy tool, does autolink URLs, that would be easiest to fix this small issue. Otherwise, just putting in the full syntax would work in both cases.