search

meilisearch / documentation

Meilisearch documentation
https://docs.meilisearch.com
MIT License
147 stars 241 forks source link

Test versioning plugin for Vuepress #705

Closed fharper closed 3 years ago

bidoubiwa commented 3 years ago

What do you mean by that? Do you want to keep a documentation version for every MeiliSearch release? Like quentin described in this issue : https://github.com/meilisearch/documentation/issues/197 ?

dichotommy commented 3 years ago

@bidoubiwa Yes, exactly! Versioning is not super helpful right now, but it is a must-have for the documentation after we hit v1.0.

Before we seriously consider switching to Docusaurus or a similar tool, I'd like to test out the Vuepress versioning plugin I found. I'm still not sure if it will work for our use-case.

Repo: https://github.com/appcelerator/docs-devkit/tree/develop/packages/vuepress/vuepress-plugin-versioning Docs: https://titanium-docs-devkit.netlify.app/guide/versioning.html

bidoubiwa commented 3 years ago

I looked at it in the past. It has not a lot of star, doesn't look to be maintained a lot but it seems it has evolved in the previous month. Except from this option I did not find any other plugin. We still should try at least to make it work.

If it does not work

The other solution would be to create an in-house option but this should require some thought. It is not clear how we can manage that the most efficiently possible.

  1. Should we have multiple directories with copies of the documentation each supporting a specific version. Considering the fact that 99% of the content between dir's would be the same?
  2. Should we look for a smart system where only the changed files would be in a sub-folder and they would be auto-completed with the main folder?
  3. Or any more complex system?

Does Docusaurus provide an easy solution for that?

bidoubiwa commented 3 years ago

@tpayet @qdequele @eskombro Could you give your opinion on the matter, or do you have any idea on how to handle this issue?

dichotommy commented 3 years ago

Does Docusaurus provide an easy solution for that?

@bidoubiwa Yep, it is one of their main features. https://docusaurus.io/docs/en/versioning

qdequele commented 3 years ago

My proposition is: we will certainly change the documentation render engine with the new version on which the designer and the front end developer will work. We will certainly use Docusaurus. So, during the beta of the v1, we will also have the ability to test the beta of the new documentation. We could use a different subdomain like beta-docs.meilisearch.com. Like Docusaurus already have a versioning feature, after this change, we will be able to use it.

dichotommy commented 3 years ago

We concluded that Appcelerator's versioning plugin for VuePress does not have enough active maintainers or support for us to use it comfortably with our docs. Instead, we will go forward with Docusaurus.