Skip to content
This repository was archived by the owner on Jan 11, 2023. It is now read-only.
This repository was archived by the owner on Jan 11, 2023. It is now read-only.

[Docs] Switch from Jekyll to Gatsby #5047

@jasonLaster

Description

@jasonLaster

Our landing page & docs are currently built with jekyll and hosted with github pages. It would be nice to switch to Gatsby and Netlify.

Features of the current setup:

  • configs are in debugger.html
  • deploys happen when a PR is merged
  • everything is markdown

Advantages of the new setup:

  • Layouts and themes are easier (landing page, docs)
  • Docs are searchable
  • Netlify offers analytics (how often are blog posts read, how often are docs read, how much traffic do we get from sources)

Here is a tutorial on how one project got setup w/ gatsby + netify + contentful and algolia. I dont think we need contentful yet but it's cool :)

NOTE: this is a big project, but would be a lot of fun. I'd be happy to mentor if you're interested and i think we can land the new gatsby site incrementally. So it doesn't all have to be done by one person and in one chunk. Also, just getting started and sharing what you learn is helpful too!

Also, one other route is to use Docusaurus which might be more out of the box. Or one of the gatsby starter projects like gatsby-starter-docs.

Lastly this issue #1921 shows some mockups i did of what a debugger.html landing page and docs page could look like :) disregard the ugly blue, just wanted to start the conversation!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions