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

Links to README files from package pages #201

Closed
hulpke opened this issue May 17, 2020 · 5 comments
Closed

Links to README files from package pages #201

hulpke opened this issue May 17, 2020 · 5 comments

Comments

@hulpke
Copy link
Contributor

hulpke commented May 17, 2020

Reported by Samuel Lelievre:

By the way, the webpage for the "TransGrp" GAP package,

https://www.gap-system.org/Packages/transgrp.html

has the following excerpt:

Online documentation

TransGrp: [ HTML] version [ PDF] version

Download

[README] ...

in which he links to the README and the HTML version
of the documentation appear to be broken.

I suspect part is the change from README to README.md which had been recommended to me.

@olexandr-konovalov
Copy link
Member

@hulpke this seems to be a systematic problem for all packages. Perhaps an oversight while making switch to jekyll, @fingolfin ?

@olexandr-konovalov olexandr-konovalov changed the title Links on transgrp page Links to README files from package pages May 17, 2020
@fingolfin
Copy link
Member

That seems likely, but your guess is as good as mine.

@fingolfin
Copy link
Member

@ruthhoffmann and me just run into this again, and I checked: the files are there, the server simply refuses to transmit them. But I don't understand why; perhaps a server configuration issue (it may not like custom extensions like in README.transgrp).

If we can move the manuals into the GapWWW repo (see issue #223) then this would be easily resolved.

In any case, we are also discussing whether to provide these files at all; instead we are tempted to simply link to their counterparts on the package homepages.

@olexandr-konovalov
Copy link
Member

Two considerations in favour of the existing way (i.e. providing these files):

  • the package homepage may migrate or disappear, and the links will no longer be valid.
  • the version on package homepage may be newer than the one redistributed with GAP.

@fingolfin
Copy link
Member

In the meantime, we removed all these README links, so they are in particular all "fixed" this way... ;-)

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

3 participants