Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
aakoch opened this issue Mar 10, 2024 · 0 comments · May be fixed by #723
Open

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

aakoch opened this issue Mar 10, 2024 · 0 comments · May be fixed by #723

Comments

@aakoch
Copy link

aakoch commented Mar 10, 2024

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

Describe the bug
Commit 0b79585 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.

@jmehrens jmehrens linked a pull request Mar 10, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant