-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
fix(docs): completing the url so that the link is correct #6545
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/bootstrap-vue/bootstrap-vue/3TDUv57phC9H6iavxJVG8YcnUNNE |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit d134c20:
|
Codecov Report
@@ Coverage Diff @@
## dev #6545 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 299 299
Lines 10153 10153
Branches 2521 2521
=========================================
Hits 10153 10153
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
The URLs in the docs are actually valid, and should work without having to type in the protocol. https://www.paulirish.com/2010/the-protocol-relative-url/ However, as described in the above link. There might be security issues with this "technique". So perhaps it's worth changing the docs to present a better example for the users. |
I did not know urls with relative protocol until this morning (I am from Brazil), after reading a little I found these links that reinforce the update in the documentation, if they think it is necessary. Thank you so much for responding so quickly. Protocol Relative urls are a anti-pattern and here too. And as well noted in the quote to Paul Irish they represent a security risk. Other libraries like Vue and Bootstrap do not use a relative protocol when accessing cdn resources. |
Thanks @willidert! |
Describe the PR
Hi, I was trying to apply the library to a personal project when I noticed a small error in the documentation. The links in the part that indicate that the library can be imported into html were missing the protocol, which caused a little inconvenience having to enter them manually. I took the liberty of making the changes and submitting this PR, I apologize for not opening an issue first, I am still learning to collaborate with open source projects.
PR checklist
What kind of change does this PR introduce? (check at least one)
fix(...)
, requires a patch version updatefeat(...)
, requires a minor version updatefeat(...)
, requires a minor version updatefix(...)
, requires a patch or minor version updatechore(docs)
, requires a patch version updateDoes this PR introduce a breaking change? (check one)
The PR fulfills these requirements:
dev
branch, not themaster
branch[...] (fixes #xxx[,#xxx])
, where "xxx" is the issue number)fix(alert): not alerting during SSR render
,docs(badge): update pill examples
,chore(docs): fix typo in README
, etc.). This is very important, as theCHANGELOG
is generated from these messages, and determines the next version type (patch or minor).If new features/enhancement/fixes are added or changed:
If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes: