FUNDING.yml custom links does not include information on valid formats

[andrewnicols]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository#about-funding-files

What part(s) of the article would you like to see updated?

The sections on Custom URLs do not provide adequate information on the valid formats for a URL.

The following is the entire information:

Custom URL | custom: LINK1 or custom: [LINK1, LINK2, LINK3, LINK4] Here's an example FUNDING.yml file:

github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]

Note If a custom URL in an array includes :, you must wrap the URL in quotes. For example, "https://www.paypal.me/octocat".

The example, and the last note suggests that valid custom URL formats include values such as:

• octocat.com
• octocat.com/example
• octocat.com/example/#fund-me

However there is no schema validation to confirm this.

We encountered this as Packagist treats all of the above valid examples as invalid due to the lack of scheme: https://github.com/composer/composer/pull/12244

Additional information

No response

[welcome[bot]]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[kristina-zd]

uto, 17. pro 2024. 15:36 welcome[bot] @.***> je napisao:

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines https://docs.github.com/en/contributing.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/35690#issuecomment-2548619425, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYGIPKJPFFZV2N4NMSJGOQD2GAZFBAVCNFSM6AAAAABTYR5WZ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNBYGYYTSNBSGU . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[nguyenalex836]

@andrewnicols Thank you for raising this issue! I'll get this triaged for review :sparkles: Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

[andrewnicols]

Thanks,

As @stof has pointed out on https://github.com/composer/composer/pull/12245 the current value is treated as a path due to the lack of scheme.

If the value is expected to be manipulated in some way to be useful this needs to be detailed. I assume that if it is missing the scheme then the expectation is that it should be prefixed with https:// but this isn't clear and I can't find any validation for it either.

[github-actions[bot]]

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:

[github-actions[bot]]

This is a gentle bump for the docs team that this issue is waiting for technical review.

[github-actions[bot]]

This is a gentle bump for the docs team that this issue is waiting for technical review.

[github-actions[bot]]

This is a gentle bump for the docs team that this issue is waiting for technical review.

[Sharra-writes]

I found an SME to clarify that custom links can be "any string that's a valid http:// or https:// URL, or that becomes one if you prefix it with http://." With that in mind, I'm going to open this up to the community if you or someone else wants to open a PR with that information inserted where it seems like it would be most helpful. 💛