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

Could we support parsing more than one URL for homepage? #363

Closed
barracuda156 opened this issue Oct 14, 2023 · 9 comments
Closed

Could we support parsing more than one URL for homepage? #363

barracuda156 opened this issue Oct 14, 2023 · 9 comments

Comments

@barracuda156
Copy link

See: https://trac.macports.org/ticket/68460

Unless there are reasons not to, IMO, it is desirable. It is not a rare case when there is a separate website with documentation and then a development repo, or alike.

@ryandesign
Copy link
Contributor

As explained in that Trac ticket, the homepage option is intended to contain one URL, not multiple.

@barracuda156
Copy link
Author

As explained in that Trac ticket, the homepage option is intended to contain one URL, not multiple.

I have seen the statement, I did not see any reasoning for that. It is technically complicated to add an ability to parse more than one URLs? Or why not?

@neverpanic
Copy link
Member

I regularly use port gohome with port names, and expect that to open one page in my browser. How would you envision port gohome would behave with more than one URL?

I'd think it would be pretty bad user experience if twelve URLs in a Portfile would open twelve browser tabs when invoking port gohome.

@barracuda156
Copy link
Author

That is a fair reason to have a single homepage.

Could we consider additional, but distinct field? Or you think it is unneeded? (Just asking, it is not a case where I see a point in trying to convince someone.)

@jmroot
Copy link
Member

jmroot commented Oct 27, 2023

Additional URLs can already be listed in the long_description or even the notes if it's important for users to know about them.

@barracuda156
Copy link
Author

@jmroot Ok, fair enough. Let me close this.

@barracuda156 barracuda156 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 28, 2023
@Dave-Allured
Copy link
Contributor

Please re-open this for discussion. I favor allowing more than one URL listed for "homepage", for the simple reason given originally. Independently I ran into this in PR macports/macports-ports#21729. It was the same thing. Upstream sports a master website for documentation, plus a github repo for development and release distribution. This seems like a pretty modest extension for the "homepage" directive.

@neverpanic said:

I regularly use port gohome with port names, and expect that to open one page in my browser. How would you envision port gohome would behave with more than one URL?

Simple. Open only the first one.

@mascguy
Copy link
Member

mascguy commented Dec 12, 2023

Please re-open this for discussion. I favor allowing more than one URL listed for "homepage", for the simple reason given originally. Independently I ran into this in PR macports/macports-ports#21729.

It was the same thing. Upstream sports a master website for documentation, plus a github repo for development and release distribution. This seems like a pretty modest extension for the "homepage" directive.

I'd suggest choosing one of their sites - either the documentation site, or the GitHub repo - particularly if each one links to the other.

Personally I tend to favor the repo, as not all documentation sites are constantly updated. Making the repo the most up-to-date source for project info, etc.

Regardless, the key point is that we're not trying to provide links to every possible information source for a project.

Does that make sense?

Anyone else... thoughts?

@barracuda156
Copy link
Author

@mascguy TBH implementing it should be trivial, and I do not think we face a realistic concern that someone gonna add a ridiculous number of URLs (or just limit those to exactly two when parsing portfile).
Having said that, it would be a minor improvement, and given that so many things are broken and some are disputable, this one is perhaps not worth arguing about :) I would rather have two URLs than one, but can certainly live with a single.

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

No branches or pull requests

6 participants