Skip to content

Investigate migrating site to Laika? #545

@valencik

Description

@valencik

Our current site was built with the help of 47 Degrees (now Xebia) and has served us well for the last couple of years.
However there remains some issues that I believe would be best solved by migrating to Laika.

Unfamiliar Tech Stack

The current site uses jekyll which, while popular overall, is not particularly familiar to the Scala ecosystem.
The majority of Typelevel projects now use sbt-typelevel and Laika to manage their builds and construct a documentation site.

Typelevel developers are used to the build tooling required to update a project's documentation, it's just sbt!
The current site requires a ruby installation, and while there is a nix flake to aid with that, I have still seen several people avoid building the website locally because of unfamiliarity with the setup.

Page Discoverability

The current site's main navigation feature is the top level nav bar.

Image

And then within one of those top level pages we can further split into sub sections on that same page:

Image

I believe this navigation structure is too limiting.
There hasn't always been an obvious place for new content to live.

Consider the Platforms page https://typelevel.org/platforms/ which largely repeats the content found in the Projects page.
This perhaps instead could have been a sub-section of "Projects". Or each platform could have been a sub-section of Projects.

Additionally there's the GSoC page https://typelevel.org/gsoc/. This currently isn't discoverable through the main navigation.

I think the left navigation panel, that Laika offers is a much easier way to display and discover the pages available to the user.

Image

What Next?

I am not asking for someone to go off and rebuild our site in sbt-typelevel and Laika just yet.
I think we need to discuss and think through the pro/cons.
What features does the current site have that might be hard to offer in a Laika site?
What other benefits would we get from migrating to a Laika site?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions