From d06834c5cc2239f828f35b6816a09fc17ff99f34 Mon Sep 17 00:00:00 2001 From: Pavel Reznikov Date: Sun, 6 Mar 2016 12:09:51 -0800 Subject: [PATCH] add faq --- Gruntfile.js | 7 ++++++- README.md | 8 ++++++++ doc/FAQ.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 doc/FAQ.md diff --git a/Gruntfile.js b/Gruntfile.js index e2c27b2..d4c7714 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -69,6 +69,11 @@ module.exports = function(grunt) { target: './doc/README.md' } }, + faq: { + options: { + target: './doc/FAQ.md' + } + }, }, jshint: { @@ -93,7 +98,7 @@ module.exports = function(grunt) { }, }, docs: { - files: ['README.md', 'doc/README.md'], + files: ['README.md', 'doc/README.md', 'doc/FAQ.md'], tasks: ['doctoc'], options: { }, diff --git a/README.md b/README.md index e9a39f5..d455af7 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ Join gridstack.js on Slack: https://gridstackjs.troolee.com - [Basic usage](#basic-usage) - [Migrating to v0.2.5](#migrating-to-v025) - [API Documentation](#api-documentation) + - [Questions and Answers (Q&A)](#questions-and-answers-q&a) - [Touch devices support](#touch-devices-support) - [Use with knockout.js](#use-with-knockoutjs) - [Use with angular.js](#use-with-angularjs) @@ -136,6 +137,13 @@ when they will be completely removed. Please check out `doc/README.md` for more information about gridstack.js API. +## Questions and Answers (Q&A) + +Please feel free to as a questions here in issues, using [Stackoverflow](http://stackoverflow.com/search?q=gridstack) or [Slack chat](https://gridstackjs.troolee.com). +We will glad to answer and help you as soon as we can. + +Also please check our FAQ `doc/FAQ.md` before asking in case the answer is already there. + ## Touch devices support Please use [jQuery UI Touch Punch](https://github.com/furf/jquery-ui-touch-punch) to make jQuery UI Draggable/Resizable diff --git a/doc/FAQ.md b/doc/FAQ.md new file mode 100644 index 0000000..2e17c54 --- /dev/null +++ b/doc/FAQ.md @@ -0,0 +1,51 @@ +Frequently asked questions +========================== + + + +**Table of Contents** *generated with [DocToc](http://doctoc.herokuapp.com/)* + +- [Gridstack doesn't use bootstrap 3 classes. Why you say it's bootstrap 3 friendly.](#gridstack-doesnt-use-bootstrap-3-classes-why-you-say-its-bootstrap-3-friendly) +- [How can I create a static layout using gridstack.](#how-can-i-create-a-static-layout-using-gridstack) + + + +### Gridstack doesn't use bootstrap 3 classes. Why you say it's bootstrap 3 friendly. + +**Q:** + +Original issue #390: + +> Hi, +> +> Excuse my ignorance but on your site you write "responsive bootstrap v3 friendly layouts" but how? +> +> In none of the examples you actually make use of any bootstrap classes. You add it to head but if you do that with gridster it works exactly the same.. +> +> What does gridstack do different then gridster? +> +> Reason I'm asking is because I have bootstrap HTML templates I want to put them in the grid so users can move it all around .. then when done have a normal html page (without the draggable grid). I thought gridstack would help to do that in favor of gridster but so far I have not seen any difference between the 2.. +> +> Thanks! + +**A:** + +We never declare that gridstack uses bootstrap classes. We say that gridstack could be responsive (widgets are not fixed width) it works well on bootstrap 3 pages with fixed or responsive layout. That's why it says bootstrap 3 friendly. + +It wasn't a goal for gridstack to create bootstrap 3 layouts. It's not a goal now neither. The goal of gridstack is to create dashboard layouts with draggable/resizable widgets. + +Gridstack uses internal grid to implement its logic. DOM nodes are just interpretation of this grid. So we or you probably could create a third party library which exports this internal grid into bootstrap 3/bootstrap 4/absolute divs/whatever layout. But I don't see this as part of gridstack core. As the same as support of angular/knockout/whatever libraries. We're doing all necessary for smooth support but it will never be a part of core. + +The main idea is to build as simple and flexible lib as possible. + + +### How can I create a static layout using gridstack. + +**Q:** + +How can I create a static layout not using jQuery UI, etc. + +**A:** + +The main propose of gridstack is creating dashboards with draggable and/or resizable widgets. You could disable this behavior by setting `static` option. At this point you will probably +still need to include jQuery UI. But we will try to decrease dependency of it in near future.