Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redesign and migrate site #932

Closed
dichotommy opened this issue May 21, 2021 · 2 comments · Fixed by #2359
Closed

Redesign and migrate site #932

dichotommy opened this issue May 21, 2021 · 2 comments · Fixed by #2359
Assignees

Comments

@dichotommy
Copy link
Contributor

The decision was recently taken to switch the documentation site framework from VuePress to Docusaurus. The main motivation is the built-in versioning feature, which is essential for MeiliSearch v1 (expected to release by the end of 2021).

@dichotommy
Copy link
Contributor Author

dichotommy commented Feb 8, 2022

Docusaurus migration: canceled or postponed

After some reflection, we are not sure that the benefit of the migration will be greater than the cost, or that Docusaurus is the best solution for us.

What's next?

We need to go back to the drawing board and consider all possible solutions. Alongside Docusaurus, there are two possible solutions on opposite ends of the difficulty spectrum.

  1. Employ the same stack used for the landing page + resource center to create a custom documentation site

This is the best solution for having visual unity / a consistent brand identity between our different sites, and is probably the most maintainable since it doesn't rely on an outside technology. It also gives us the possibility to build the documentation site inside another of our sites, such as our resource center. However it would also require by far the most work: both for the developers to recreate the site and plugins, and for the docs team to adapt to new tools + workflow.

  1. Migrate our site to VuePress-2.

This is the "easiest" solution: it would not require our developers to completely recreate our plugins or our writers to learn new workflows. The main downside is that it would put us somewhat at the mercy of VuePress's maintainers, as well as its limitations. It would resolve the current situation (deprecated stack, dependency problems) with minimal cost, but might also be a "stop-gap" solution that needs to be revisited later on. Consider the fact that we have at least one dedicated React developer, but no dedicated Vue developer on our team.

@dichotommy dichotommy changed the title Migrate site to Docusaurus Migrate site Feb 8, 2022
@dichotommy dichotommy changed the title Migrate site Redesign and migrate site Feb 21, 2023
@dichotommy
Copy link
Contributor Author

We are currently working on a new documentation site using Next.js. We expect the first version of the site to be released around the start of April.

@maryamsulemani97 maryamsulemani97 linked a pull request Apr 13, 2023 that will close this issue
6 tasks
@maryamsulemani97 maryamsulemani97 pinned this issue Apr 17, 2023
@maryamsulemani97 maryamsulemani97 unpinned this issue Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants