Skip to content

Add Pinia to developer documentation

Stanislav Lashmanov requested to merge slashmanov/pinia-docs-2 into master

What does this MR do and why?

This MR is an outcome of the discussions that took place in New Pattern: Replace Vuex with Pinia (#456463 - closed). Motivation for this MR is also described in the linked issue.

With this change we would allow Pinia to be used in GitLab's codebase. It also provides clear guidance on which state manager to use: Pinia or Apollo.

In a nutshell:

  • Vuex is deprecated, this should be visible across the documentation
  • Pinia and Apollo are allowed to be used as a replacement to Vuex
  • Pinia can be used as an alternative to Apollo client state management and vice versa, documentation will give you guidance which one to pick
  • You can combine Pinia and Apollo in very specific cases
  • Documentation will provide you with general guidance on how to write new Pinia stores

MR acceptance checklist

Edited by Stanislav Lashmanov

Merge request reports