Skip to content

Remove store singleton pattern from docs

Mark Florian requested to merge remove-store-singleton-from-docs into master

What does this MR do?

Removes from the documentation the pattern of exporting a default Vuex store singleton, favouring only a factory function.

This pattern is a bad practice largely because it can lead to stale state preserved between tests, or implicit (rather than the preferable explicit) coupling between different Vue applications on the same page that use the store.

This came up in an MR review: !34742 (comment 379821497).

cc @justin_ho

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Mark Florian

Merge request reports