srid / zulip-archive Goto Github PK

Create a Actions workflow that automatically deploys generated .html files to GitHub Pages (in a separate repo).

Should probably use docker image of zulip-archive (built via nix).

cf. #21 (comment)

From https://funprog.srid.ca/haskell/zulip-archive-looking-for-maintainer.html

Using https://github.com/kowainik/co-log

This is mostly visible on phones:

We probably want them to be shown in smaller, scrollable frame, similarly to Zulip itself.

No two topics should have the same slug.

srid/rib#118

cc @prikhi

The description field is currently set to a HTML value, as such it doesn't seem to appear in link preview.

Zulip API can return the original Markdown format. Setting apply_markdown to true in /api/get-messages will get the original format. But we need the HTML as well, so maybe this API should be invoked twice.

Once both the formats are stored in the Message object (and consequently messages.json) we can use the markdown format in OGP description.

Custom configuration through YAML/TOML/Dhall would make it easy to run archive on arbitrary Zulip instance.

https://funprog.srid.ca/general/late-renaming-of-topics-can-break-archive-threads.html

For example, images are uploaded in this topic: /haskell/selective-functor-paper-example.html

And it currently renders as:

https://ema.srid.ca/guide/helpers/blaze

Also revamp the design of the generated site. Make it awesome.

Not sure if it is possible to get via Zulip API, but it would be nice to be able to show instance logo on top of archive page, together with custom favicon in tab card.

This would help display posts as rich results in search result pages:
https://developers.google.com/search/docs/guides/intro-structured-data
https://schema.org/docs/schemas.html

The few relevant types I can think of:

• Breadcrumbs: https://developers.google.com/search/docs/data-types/breadcrumb
  https://schema.org/BreadcrumbList
• Article: https://developers.google.com/search/docs/data-types/article
  https://schema.org/Article
• Or the DiscussionForumPosting Article-subtype: https://schema.org/DiscussionForumPosting
• Organization(for site name, logo, url to this repo, etc): https://schema.org/Organization

Allow some streams to be blacklisted. Which means they should not have their HTML generated, and be excluded from the main index.

For eg., #haskell-beginners (because it is now locked and unused).

For example #narrow/stream/201385-Haskell should be rewritten to /haskell/. Likewise for topic and message links.

At https://funprog.srid.ca/mtl/, there are no messages shown, even though this message was sent nearly two months ago.

This would really speed up the daily Publish CI jobs.

Steal workflow YAML from https://github.com/srid/TheMotteDashboard

A sitemap of all the threads would help crawlers and improve search engine discovery. You can point crawlers to the sitemap using the Sitemap: <full-url> directive in a robots.txt file, or by sending them a ping. A sitemap can have a maximum of 50,000 URLs. Beyond that, you need to generate a sitemap index file that points to the different sitemaps.

Not sure if this is a rib issue or a zulip-archive issue, but you could leverage this package I published recently to build the sitemaps and sitemap index: https://hackage.haskell.org/package/sitemap-gen