search

solid / specification

Solid Technical Reports
https://solidproject.org/TR/
MIT License
490 stars 45 forks source link

Management of github.io spec URLs after transition #215

Open csarven opened 3 years ago

csarven commented 3 years ago

At the same time resolving https://github.com/solid/specification/issues/141 (Determine the URIs for the specifications) and https://github.com/solid/solidproject.org/issues/247 (Publish a URI Persistence Policy) , existing github.io spec URLs need some attention. Options:

For the time being, if possible, I find redirect most appealing as there are existing references to solid .github .io / specification /* . This is the same issue for documents published via gh pages by panels in their respective repositories.

elf-pavlik commented 3 years ago

I think solidproject.org could also proxy content published to github.io. Specs will still use solidproject.org as canonical URL. Otherwise you would need to have bunch of webhooks to update specs as they get updated in github repos.

csarven commented 3 years ago

If I understand you correctly, that might be addressing a related but different issue ie. publishing under solidproject.org/TR/ . See https://github.com/solid/specification/pull/216 .

But, please do correct me if I've misunderstood the proxy solution.

The point of this issue is to how to downplay/deprecate/redirect the use of existing github.io URLs out there for the specs in favour of using the new URLs.

I'd be okay with pulling down gh-pages and have existing references resolve to 404.

I'm not sure if HTTP level redirect (301) is possible with gh-pages. If possible, great.

There is the option to have gh-pages branch index.html return 200 with meta http-equiv=refresh for the redirect. For the record: I strongly dislike this bad practice. It "works" but only meaningful/useful for some agents.

Edit: I can live with either option. Not to imply as good practice/desirable but have seen several W3C group reports leaving github.io to dust; 404.

csarven commented 3 years ago

If you mean link rel=canonical, sure, good to have FWIW.

justinwb commented 3 years ago

Hyperlink in the body - right at the top - pointing to the new home.

I'm not sure if HTTP level redirect (301) is possible with gh-pages. If possible, great.

Yes, this is possible. It requires using the jekyll redirect module and putting a redirect rule in the front matter of the document that needs to be redirected.

csarven commented 3 years ago

As I understand the jekyll redirect module, that's not an HTTP level redirect. It is same as the HTML solution mentioned above. The original response is a 200. Some agents may interpret the meta refresh for redirect.

csarven commented 2 years ago

Noting here that I am editing some comments in this repo to change references to solidproject.org from github.io where applicable. Motivation is to reduce potential references to URLs that's not canonical or persistent.