Update documentation about usage of Vuex
What does this MR do?
Our FE guidelines for Vuex state the following:
To manage the state of an application you should use Vuex.
This can be misleading since Vuex is not necessarily required for maintaining basic state. Consider the following example:
We want to implement an app that renders a card which displays two numbers (MRs created, issues created). Those numbers are being fetched from an API. There is no user interaction or mutation of data happening. The data is not consumed by other parts of the application.
Introducing Vuex for state management in basic apps require engineers to add a ton of boilerplate code for actions, mutations, getters and specs. While this definitely pays off for more complex apps, basic apps don't profit from a sophisticated architecture and maintaining component state could be much more straightforward in such cases.
This MR suggests to update the usage guidelines for Vuex to be less compulsory. Let's not enforce the usage of Vuex but rather list cases where Vuex adds value in the long run.
Related issues
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.