documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Pre-prod documentation on Netlify does not display all the `cURL` code samples

Open curquiza opened this issue 3 years ago • 2 comments

This is a known problem: the pre-prod documentation does not display all the samples in the tabs. This is expected since our "code-samples fetcher" plugin only fetches the code-samples on master and our dev-branch is prepare-vX.X.X and not master.

We could find a solution to make the code-samples fetcher for pre-prod and not only for prod so that our users can completely use it, for example by passing a branch name that would replace master

See the user confusion here: https://github.com/meilisearch/MeiliSearch/issues/1603#issuecomment-902921302

curquiza avatar Aug 23 '21 08:08 curquiza

Not that we shouldn't try to address this sooner, but I believe this issue will be fixed when we migrate to docusaurus.

guimachiavelli avatar Aug 23 '21 15:08 guimachiavelli

I believe this issue will be fixed when we migrate to docusaurus.

We are no longer planning to migrate to Docusaurus. Instead, we have spoken about implementing a form of naive versioning for the v1 launch: tagging version release branches and deploying these branches as separate sites on Netlify.

The problem described in this issue will directly impact us if we go with this naive versioning. With the current code samples fetcher, all different versions of the docs would display the same code samples from master, which would not be effective for maintaining different versions of the docs.

dichotommy avatar Feb 08 '22 13:02 dichotommy

closing as we use Vercel instead of Netlify on the new site.

maryamsulemani97 avatar Apr 13 '23 13:04 maryamsulemani97