Taken: A Docusaurus setup to replace the existing Portal

Description

There are some limitations to the gitbooks implementation that we can’t get around. Community Development would like someone to create a new framework for us with docusaurus that basically looks and behaves exactly like the existing portal.

Criteria

  • searching with algolia or equiv
  • easily maintained css
  • should sit in the same repo as the existing content?
    • or can we set up a new repo that ingests content from the primary repo?

Interested?

If you feel you, or your team, is capable of handling this task: please feel free to ask questions in this thread, reach out to [email protected], or DM me in the chat @rich.brown.

Funding will be provided through the Grants Program framework.

2 Likes

Is there a reason to use docusaurus instead of https://www.mkdocs.org/? Localization looks to be a main positive of docusaurus over mkdocs.

I can probably look to tackle this.

searching with algolia or equiv

Docusaurus doesn’t support search out of the box. It’s tentatively planned for v2. How big of a concern is that?

https://github.com/facebook/Docusaurus/issues/776

actually I stand corrected

Also, the repo will need to be ingested and altered slightly, but can be largely maintained as is.

or can we set up a new repo that ingests content from the primary repo?

A team is now working on this project.

1 Like