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

Broken (unnecessarily munged) repo hyperlinks in library reference pages #11996

Open
2 tasks done
jezhill opened this issue Oct 21, 2024 · 0 comments
Open
2 tasks done
Labels
Component: Website Issues related to arduino.cc, but not the documentation content Type: Bug

Comments

@jezhill
Copy link

jezhill commented Oct 21, 2024

Describe the problem

After adding some of my libraries to the library registry, I note that the automatically-generated library pages (example: https://docs.arduino.cc/libraries/keyhole/ ) are taking the repo URLs I supplied (in that case: https://bitbucket.org/jezhill/Keyhole ) and automatically appending .git to them. This leads to a potentially-invalid hyperlink.

To reproduce

Expected behavior

Expected behavior is to see bitbucket's web-interface version of the repo. This happens correctly if you point your browser to the original URL listed in https://github.com/arduino/library-registry/blob/main/repositories.txt (i.e. https://bitbucket.org/jezhill/Keyhole without the .git suffix)

Additional context

Of course you could (rightly) argue that this particular problem is a bitbucket.org server issue rather than an arduino.cc issue. But (leaving aside the fact that, as a non-paying user of bitbucket, I'm not going to get the attention of their support or webmaster) the general principle remains that it's probably wiser to just not automatically change the provided URL on the arduino.cc side, to avoid any such unforeseen weirdness.

Note that, as an argument to git clone the URL works fine both with and without the suffix. This particular problem only occurs with the web interface. In any case, I don't see any advantage in adding the .git suffix, especially to a hyperlink that is designed for human clicking.

Issue checklist

  • I searched for previous reports in the issue tracker
  • My report contains all necessary details
@per1234 per1234 transferred this issue from arduino/library-registry Oct 21, 2024
@per1234 per1234 added Type: Bug Component: Website Issues related to arduino.cc, but not the documentation content labels Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Website Issues related to arduino.cc, but not the documentation content Type: Bug
Projects
None yet
Development

No branches or pull requests

2 participants