summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJose Ivan Vargas <jvargas@gitlab.com>2018-02-05 13:19:46 -0600
committerJose Ivan Vargas <jvargas@gitlab.com>2018-02-05 13:19:46 -0600
commitf915dda0c87b8bb9448581bb6456d5129e47b342 (patch)
tree228ffd8352cabc06d1d3174f59fdad87b2c65ff2
parent2150ed4094ddb67d7b403cd56360700c80e7d928 (diff)
downloadgitlab-ce-update-graphs-section-frontend.tar.gz
Update the fe documentation to specify the usage of d3update-graphs-section-frontend
-rw-r--r--doc/development/fe_guide/graphs.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/development/fe_guide/graphs.md b/doc/development/fe_guide/graphs.md
new file mode 100644
index 00000000000..e4e7c39f38a
--- /dev/null
+++ b/doc/development/fe_guide/graphs.md
@@ -0,0 +1,10 @@
+# Graphs
+
+GitLab currently uses multiple graphics libraries to render all the graphs, as part of our efforts to help with the maintainability of the frontend code, the only library that will be used from this point onward, will be `d3.js`
+
+`d3.js` has been battle tested on big features such as our prometheus graphs and contribution calendars. Also it gives us a couple of cool features such as:
+
+* Tree shaking webpack capabilities.
+* Compatible with vue.js as well as vanilla javascript.
+
+Of course there will be instances where creating graphs manually using SVG or canvas HTML 5 graphics will be totally doable, if that's case just make sure to not add more libraries to maintain.