Browse Source

Updated the template markdown (#4434)

文翼 6 years ago
parent
commit
104162979f
5 changed files with 17 additions and 18 deletions
  1. 2 2
      .github/ISSUE_TEMPLATE.md
  2. 9 11
      CONTRIBUTING.md
  3. 3 3
      README.md
  4. 2 1
      site/docs/extensions/treegrid.md
  5. 1 1
      site/docs/faq.md

+ 2 - 2
.github/ISSUE_TEMPLATE.md

@@ -9,9 +9,9 @@ This is the first step
 This is the second step
 Further steps, etc.
 
-[jsfiddle]() - a link to the reduced test case([fiddle template](https://github.com/wenzhixin/bootstrap-table/issues/1765)).
+Please provide an [Online Example](https://live.bootstrap-table.com) to show your problem, thanks!
 
 Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
 
 <!-- Love bootstrap-table? Please consider supporting our collective:
-👉  https://opencollective.com/bootstrap-table/donate -->
+👉  https://opencollective.com/bootstrap-table/donate -->

+ 9 - 11
CONTRIBUTING.md

@@ -29,10 +29,11 @@ restrictions:
 * Please **do not** open issues or pull requests regarding the code in [`bootstrap-table-examples`](https://github.com/wenzhixin/bootstrap-table-examples) and [`extensions plugin dependence`](https://github.com/wenzhixin/bootstrap-table/tree/develop/src/extensions) (open them in their respective repositories), the dependence list:
     * Table Editable: [x-editable](https://github.com/vitalets/x-editable)
     * Table Export: [tableExport.jquery.plugin](https://github.com/hhurz/tableExport.jquery.plugin)
-    * Table Filter: [bootstrap-table-filter](https://github.com/lukaskral/bootstrap-table-filter)
-    * Table flat-json: [bootstrap-table-flat-json](https://github.com/djhvscf/bootstrap-table-flatJSON)
-    * Table Reorder: [jquery-ui](https://code.jquery.com/ui/) and [dragTable](https://github.com/akottr/dragtable/)
-    * Table Resizable: [colResizable](https://github.com/alvaro-prieto/colResizable)
+    * Table Reorder-Columns: [jquery-ui](https://code.jquery.com/ui/) and [dragTable](https://github.com/akottr/dragtable/)
+    * Table Reorder-Rows: [tablednd](https://github.com/isocra/TableDnD)
+    * Table Resizable: [jquery-resizable-columns](https://github.com/dobtco/jquery-resizable-columns)
+    * Table Treegrid: Dependence: [jquery-treegrid](https://github.com/maxazan/jquery-treegrid) v0.3.0
+
 
 ## Issues and labels
 
@@ -59,10 +60,7 @@ Guidelines for bug reports:
    latest `master` or development branch in the repository.
 
 3. **Isolate the problem** &mdash; ideally create a live example.
-    The web tool [jsfiddle](http://jsfiddle.net/) is a very helpful for this. Consider to use these templates:
-    * [Table from html](http://jsfiddle.net/wenyi/e3nk137y/44345/)
-    * [Table from data](http://jsfiddle.net/wenyi/e3nk137y/44346/)
-    * [Table from url](http://jsfiddle.net/wenyi/e3nk137y/44348/)
+    Our [Online Editor](https://live.bootstrap-table.com) tool is a very helpful for this.
 
 
 A good bug report shouldn't leave others needing to chase you up for more
@@ -119,7 +117,7 @@ source files in [`/src/`](https://github.com/wenzhixin/bootstrap-table/tree/deve
 
 Similarly, when contributing to Bootstrap's documentation, you should edit the
 documentation source files in
-[the `/docs/` directory of the `develop` branch](https://github.com/wenzhixin/bootstrap-table/tree/develop/docs).
+[the `/site/` directory of the `develop` branch](https://github.com/wenzhixin/bootstrap-table/tree/develop/site).
 
 Adhering to the following process is the best way to get your work
 included in the project:
@@ -174,7 +172,7 @@ included in the project:
 **IMPORTANT**: By submitting a patch, you agree to allow the project owners to
 license your work under the terms of the [MIT License](LICENSE) (if it
 includes code changes) and under the terms of the
-[Creative Commons Attribution 3.0 Unported License](docs/LICENSE)
+[Creative Commons Attribution 3.0 Unported License](site/LICENSE)
 (if it includes documentation changes).
 
 
@@ -189,7 +187,7 @@ includes code changes) and under the terms of the
 ## License
 
 By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
-By contributing to the documentation, you agree to license your contribution under the [Creative Commons Attribution 3.0 Unported License](docs/LICENSE).
+By contributing to the documentation, you agree to license your contribution under the [Creative Commons Attribution 3.0 Unported License](site/LICENSE).
 
 
 ## Financial contributions

+ 3 - 3
README.md

@@ -78,13 +78,13 @@ For feature requests, bug reports or submitting pull requests, please ensure you
 
 As stated above, please read [CONTRIBUTING.md](https://github.com/wenzhixin/bootstrap-table/blob/master/CONTRIBUTING.md), especially [Bug Reports](https://github.com/wenzhixin/bootstrap-table/blob/master/CONTRIBUTING.md#bug-reports)
 
-And as stated there, please provide jsFiddle when creating issues!
+And as stated there, please provide an [Online Example](https://live.bootstrap-table.com) when creating issues!
 
 It's really saves much time.
 
-You can also use these for templates:
+You can also use our examples template via Load Examples button:
 
-[jsFiddle Bootstrap Table](https://github.com/wenzhixin/bootstrap-table/issues/1765)
+[Online Editor](https://live.bootstrap-table.com/)
 
 Your feedback is very appreciated!
 

+ 2 - 1
site/docs/extensions/treegrid.md

@@ -6,7 +6,8 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-treegrid](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/treegrid)
+Use Plugin: [bootstrap-table-treegrid](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/treegrid)</br>
+Dependence: [jquery-treegrid](https://github.com/maxazan/jquery-treegrid) v0.3.0
 
 ## Usage
 

+ 1 - 1
site/docs/faq.md

@@ -48,7 +48,7 @@ $('#eventsTable').on('click-row.bs.table', function (event, row, $element) {
 })
 ```
 
-the first parameter is always `event`: [http://jsfiddle.net/wenyi/e3nk137y/11688/](http://jsfiddle.net/wenyi/e3nk137y/11688/)
+the first parameter is always `event`: [https://live.bootstrap-table.com/code/wenzhixin/46](https://live.bootstrap-table.com/code/wenzhixin/46)
 
 and use onClickRow event: