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

readme points to non-existing user-guide #7391

Closed
andrewufrank opened this issue May 12, 2021 · 7 comments
Closed

readme points to non-existing user-guide #7391

andrewufrank opened this issue May 12, 2021 · 7 comments

Comments

@andrewufrank
Copy link

Describe the bug
on the cabal 3.4 page found with hackage, the readme points to a non-existing (404) user guide

To Reproduce
open page http://hackage.haskell.org/package/Cabal-3.4.0.0#readme and scroll down to more information, click on user guide and you get a 404 error (on may 12, 2021)

I guess to point to the actual version of the user guide is important. Google gives various answers, not all are the current 3.4.0.0 user's guide. Thank you for including the version in the title, it is shown in the google result page (together with a number of unversioned, older ones).

@Mikolaj
Copy link
Member

Mikolaj commented May 12, 2021

Confirmed. Thank you. And the 'API documentation' link is broken, too.

@emilypi: do you know if in the past the https://www.haskell.org/cabal/users-guide link somehow pointed to the newest guide (currently at https://cabal.readthedocs.io/en/latest, I think)? If so, I guess we could try to restore it and be done.

BTW, the link at https://www.haskell.org/cabal/ points to https://cabal.readthedocs.io/en/3.4/ instead. I guess any files included in a release should ideally point to the guide matching the release version while any fixed web page should point to the lastest guide.

@Mikolaj
Copy link
Member

Mikolaj commented Jun 3, 2021

@emilypi: I won't make it to today's meeting (holiday here in Poland). This ticket is the only agenda item I would have, so a kind ping. :)

Edit: and AppVeyor CI (see IRC). I guess we should just turn it off, but I think I can't, despite admin on github.

@Mikolaj
Copy link
Member

Mikolaj commented Sep 10, 2021

@emilypi: the problem persists for https://hackage.haskell.org/package/Cabal-3.6.1.0

@gbaz
Copy link
Collaborator

gbaz commented Sep 10, 2021

Redirect added, but we should update the link properly.

@Mikolaj
Copy link
Member

Mikolaj commented Oct 29, 2021

@gbaz: is anything left to do still?

BTW, yesterday the "API documentation" link at https://github.com/haskell/cabal/blob/master/Cabal/README.md stopped working properly. Should we point it to Hackage instead?

@gbaz
Copy link
Collaborator

gbaz commented Oct 29, 2021

I'll close, but also yes pointing the api documentation link to hackage sounds like a good idea.

@gbaz gbaz closed this as completed Oct 29, 2021
Mikolaj added a commit to Mikolaj/cabal that referenced this issue Nov 29, 2021
@Mikolaj
Copy link
Member

Mikolaj commented Nov 29, 2021

@andrewufrank or @gbaz would you have a quick look at #7841 and nod you approval?

mergify bot added a commit that referenced this issue Nov 30, 2021
Update Cabal/README.md (see #7391)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants