Website is down

[turion]

The website for criterion is linked in many places as http://www.serpentine.com/criterion, but it is offline.

[Lysxia]

Right now it looks online to me, but it's an http link, which may be a problem depending on browser extensions; and the https certificate is out of date.

[turion]

https://www.isitdownrightnow.com/serpentine.com.html says that the site is certainly down. Maybe you still have it cached?

[turion]

Also, the https variant doesn't work for me either.

[RyanGlScott]

I am also able to view the website, and I don't have it cached.

That being said, I think it is time to consider migrating the website away from www.serpentine.com to a different place. (Perhaps somewhere on github.io using GitHub pages?) I don't own www.serpentine.com, which means that there's nothing I could do if the website truly goes down. Nor can I update the website should we change the material presented on that page, as was recently done in #268.

[turion]

When I SSH into my webserver, I can curl the site (but only http). From my personal laptop, I cannot curl it. It says:

❯ curl http://www.serpentine.com/criterion/tutorial.html
curl: (6) Could not resolve host: www.serpentine.com

So there is probably something wrong with DNS, but not only on my laptop, since isitdownrightnow.com says it's down as well. I checked two other similar services: https://www.checkifdown.com/ sometimes says it is up (although a 500 error), sometimes it is down, https://downforeveryoneorjustme.com/serpentine.com?proto=http&www=1 says it is up.

Maybe a cloudflare issue?

[turion]

github.io or readthedocs sound like sensible places.

[RyanGlScott]

If my understanding of how GitHub Pages works is correct, we'd need to:

1. Enable the appropriate options in https://github.com/haskell/criterion/settings/pages. (I'd need a @haskell administrator to help me with this step, as I don't have the permissions to do this.)
2. Add a GitHub Actions workflow that uses the deploy-pages action to build the website (i.e., navigate to the www subdirectory and run make) and deploy it.

[ulysses4ever]

The website is down again. It'd be great to fix this issue, e.g. as discussed above, via GitHub Pages. Should we scream about the insufficient permissions (to enable Pages) at https://github.com/haskell/meta/ ? I am happy to assist if everyone is busy. (I'm not an admin but I know how to scream.)

I feel like since the tutorial is just one page, maybe it should simply be included in sdist?.. After all, people include whole mdbooks in Hackage releases: https://hackage.haskell.org/package/text-display/docs/doc/book/Introduction.html Making sure its packaging is correctly automated may be more hussle then github pages though.

[Bodigrim]

Why not shove it all into README.md?

[ulysses4ever]

Yes, that's an option. I seem to remember that it's hard to have image paths work properly on both Hackage and GitHub, but maybe with enough care it's feasible?..

<bikeshedding>I kinda like the current readme, so I'd maybe create a TUTORIAL.md or something.</bikeshedding> But the idea is the same: just convert the current tutorial from HTML to Markdown, and then let GitHub do its thing...

[Bodigrim]

Yes, that's an option. I seem to remember that it's hard to have image paths work properly on both Hackage and GitHub, but maybe with enough care it's feasible?..

The trick is to link an image from Markdown by its absolute URL, hosted at Hackage. And add an image to extra-doc-files. You can check how tasty-bench embeds example.svg: https://github.com/Bodigrim/tasty-bench/blob/master/README.md#plotting-results and https://hackage.haskell.org/package/tasty-bench-0.4.1#plotting-results.

[RyanGlScott]

I don't have a strong opinion about whether we upload the tutorial to GitHub Pages or include it in the README. The latter would have the advantage of being something that we could do now (without needing a haskell/meta administrator to intervene).

[Bodigrim]

Regarding GitHub Pages, we don't have anything at haskell.github.io right now and it does not feel right to squat it solely for Criterion documentation. So, I assume, one needs a custom domain, paid and maintained.

Putting entire documentation into README.md is much more robust approach: even if GitHub and Hackage burst in flames, the documentation is still right there, in every tarball on every machine.

[ulysses4ever]

@Bodigrim the whole domain wouldn't be squated by criterion solely: any project in this org can use haskell.github.io/${project} for its GitHub pages (see the table under https://docs.github.com/en/pages/getting-started-with-github-pages/what-is-github-pages#types-of-github-pages-sites, the Project Sites / Default site location). But I completely agree that for one simple page it's an overkill.