End of live (#4306)

* removed badges from readme * updated history * updated the README * update the github templates * update the github templates
almende · Jul 28, 2019 · 0b2a54a · 0b2a54a
1 parent 5563fc6
commit 0b2a54a
Show file tree

Hide file tree

Showing 8 changed files with 79 additions and 179 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,10 +1,3 @@
+This project is no longer in active development. See #4259 for details.
 
-Please make sure to **read the following list** before creating a new issue:
-
-* This issue tracker is not supposed to be used for questions on how to use visjs. It is intended to be used for bug reports and feature requests! In case you face yourself with a usage question, then post your question e.g. on [stackoverflow](https://stackoverflow.com/questions/tagged/vis.js) tagged with "vis.js".
-* Have you already used the [github search](https://github.com/almende/vis/issues), read the [documentation](http://visjs.org/) and looked at the [examples](https://github.com/almende/vis/tree/develop/examples)?
-* Make sure to mention which vis-component (network, timeline, graph2D, graph3d) you are referring to.
-* Make sure to use the [latest version of vis.js](https://cdnjs.com/libraries/vis) for bug reports.
-* Make sure to mention which browser and OS you are using when creating a bug report.
-* Please provide a minimal code example that demonstrates your issue. We recommend using [jsbin](jsbin.com) for that.
-* Delete this list from the actual issue.
+Please contribute to the [visjs community](https://github.com/visjs)!
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,11 +1,3 @@
-**Thank you for contributing to vis.js!!**
+This project is no longer in active development. See #4259 for details.
 
-Please make sure to check the following requirements before creating a pull request:
-
-* [ ] All pull requests must be to the [develop branch](https://github.com/almende/vis/tree/develop). Pull requests to the `master` branch will be closed!
-* [ ] Make sure your changes are based on the latest version of the [develop branch](https://github.com/almende/vis/tree/develop). (Use e.g. `git fetch && git rebase origin develop` to update your feature branch).
-* [ ] Provide an additional or update an example to demonstrate your changes or new features.
-* [ ] Update the documentation if you introduced new behavior or changed existing behavior.
-* [ ] Reference issue numbers of issues that your pull request addresses. (If you write something like `fixes #1781` in your git commit message this issue gets closed automatically by merging your pull request).
-* [ ] Expect review comments and change requests by reviewer.
-* [ ] Delete this checklist from your pull request.
+Please contribute to the [visjs community](https://github.com/visjs)!
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,15 +1,5 @@
-## Contributing
+# Contributing
 
-[Contributions](//github.com/almende/vis/blob/master/misc/how_to_help.md) to the vis.js library are very welcome! [We can't do this alone](//github.com/almende/vis/blob/master/misc/we_need_help.md).
+This project is no longer in active development. See #4259 for details.
 
-### Questions
-If you have any *general question* on how to use the vis.js library in your own project please check out [stackoverflow](http://stackoverflow.com/questions/tagged/vis.js) for thinks like that. **This is NOT a JavaScript help forum!**
-
-### Bugs, Problems and Feature-Requests
-If you really want to open a new issue:
-* Please use the [search functionality](//github.com/almende/vis/issues) to make sure that there is not already an issue concerning the same topic.
-* Please make sure to **mention which module** of vis.js (network, timeline, graph3d, ...) your are referring to.
-* Note that development happens on the `develop` git branch. Be sure to submit PRs against this branch.
-* If you think you found a bug please **provide a simple example** (e.g. on [jsbin](jsbin.com)) that demonstrates the problem.
-* If you want to propose a feature-request please **describe what you are looking for in detail**, ideally providing a screenshot, drawing or something similar.
-* **Close the issue later**, when the issue is no longer needed.
+Please consider contributing to the [visjs community](https://github.com/visjs)!
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,6 +1,7 @@
 # vis.js history
-http://visjs.org
 
+## 2019-06-08, End of Live
+- see #4259 for details
 
 ## 2017-10-12, version 4.21.0
 

diff --git a/README.md b/README.md
@@ -1,10 +1,8 @@
-# vis.js
+# vis.js (deprecated!)
 
-[![Join the chat at https://gitter.im/vis-js/Lobby](https://badges.gitter.im/vis-js/Lobby.svg)](https://gitter.im/vis-js/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+:exclamation: **This project is not maintained anymore! (See [Issue #4259](http://github.com/almende/vis/issues/4259#issue-412107497) for details)**<br/>**We welcome you to use the libraries from the [visjs community](https://www.github.com/visjs) from now on.**
 
-<a href="https://github.com/almende/vis/blob/develop/misc/we_need_help.md">
-  <img align="right" src="https://raw.githubusercontent.com/almende/vis/master/misc/we_need_help.png">
-</a>
+---
 
 Vis.js is a dynamic, browser based visualization library.
 The library is designed to be easy to use, handle large amounts
@@ -22,36 +20,21 @@ The library consists of the following components:
 
 The vis.js library was initially developed by [Almende B.V](http://almende.com).
 
-## Badges
-
-[![NPM](https://nodei.co/npm/vis.png?downloads=true&downloadRank=true)](https://nodei.co/npm/vis/)
-
-[![Dependency Status](https://david-dm.org/almende/vis/status.svg)](https://david-dm.org/almende/vis)
-[![devDependency Status](https://david-dm.org/almende/vis/dev-status.svg)](https://david-dm.org/almende/vis?type=dev)
-
-[![last version on CDNJS](https://img.shields.io/cdnjs/v/vis.svg)](https://cdnjs.com/libraries/vis)
-[![GitHub contributors](https://img.shields.io/github/contributors/almende/vis.svg)](https://github.com/almende/vis/graphs/contributors)
-[![GitHub stars](https://img.shields.io/github/stars/almende/vis.svg)](https://github.com/almende/vis/stargazers)
-
-[![GitHub issues](https://img.shields.io/github/issues/almende/vis.svg)](https://github.com/almende/vis/issues)
-[![Percentage of issues still open](http://isitmaintained.com/badge/open/almende/vis.svg)](http://isitmaintained.com/project/almende/vis "Percentage of issues still open")
-[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/almende/vis.svg)](http://isitmaintained.com/project/almende/vis "Average time to resolve an issue")
-[![Pending Pull-Requests](http://githubbadges.herokuapp.com/almende/vis/pulls.svg)](https://github.com/almende/vis/pulls)
-
-[![Test Coverage](https://codeclimate.com/github/almende/vis/badges/coverage.svg)](https://codeclimate.com/github/almende/vis/coverage)
-[![Code Climate](https://codeclimate.com/github/almende/vis/badges/gpa.svg)](https://codeclimate.com/github/almende/vis) 
-
 ## Install
 
 Install via npm:
 
-    $ npm install vis
+```sh
+npm install vis
+```
 
 Install via bower:
 
-    $ bower install vis
+```sh
+bower install vis
+```
 
-Link via cdnjs: http://cdnjs.com
+Link via cdnjs: https://cdnjs.com/libraries/vis
 
 Or download the library from the github project:
 [https://github.com/almende/vis.git](https://github.com/almende/vis.git).
@@ -64,8 +47,8 @@ To use a component, include the javascript and css files of vis in your web page
 <!DOCTYPE HTML>
 <html>
 <head>
-  <script src="webroot/vis/dist/vis.js"></script>
-  <link href="webroot/vis/dist/vis.css" rel="stylesheet" type="text/css" />
+  <script src="vis/dist/vis.min.js"></script>
+  <link href="vis/dist/vis.min.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
   <script type="text/javascript">
@@ -88,7 +71,6 @@ require(['vis'], function (math) {
 });
 ```
 
-
 A timeline can be instantiated as:
 
 ```js
@@ -99,7 +81,6 @@ Where `container` is an HTML element, `data` is an Array with data or a DataSet,
 and `options` is an optional object with configuration options for the
 component.
 
-
 ## Example
 
 A basic example on loading a Timeline is shown below. More examples can be
@@ -111,8 +92,8 @@ of the project.
 <html>
 <head>
   <title>Timeline basic demo</title>
-  <script src="vis/dist/vis.js"></script>
-  <link href="vis/dist/vis.css" rel="stylesheet" type="text/css" />
+  <script src="vis/dist/vis.min.js"></script>
+  <link href="vis/dist/vis.min.css" rel="stylesheet" type="text/css" />
 
   <style type="text/css">
     body, html {
@@ -144,28 +125,38 @@ of the project.
 
 To build the library from source, clone the project from github
 
-    $ git clone git://github.com/almende/vis.git
+```sh
+git clone git://github.com/almende/vis.git
+```
 
 The source code uses the module style of node (require and module.exports) to
 organize dependencies. To install all dependencies and build the library,
 run `npm install` in the root of the project.
 
-    $ cd vis
-    $ npm install
+```sh
+cd vis
+npm install
+```
 
 Then, the project can be build running:
 
-    $ npm run build
+```sh
+npm run build
+```
 
 To automatically rebuild on changes in the source files, once can use
 
-    $ npm run watch
+```sh
+npm run watch
+```
 
 This will both build and minify the library on changes. Minifying is relatively
 slow, so when only the non-minified library is needed, one can use the
 `watch-dev` script instead:
 
-    $ npm run watch-dev
+```sh
+npm run watch-dev
+```
 
 ## Custom builds
 
@@ -182,22 +173,22 @@ Before you can do a build:
 - Install *node.js* and *npm* on your system: https://nodejs.org/
 - Install the following modules using npm: `browserify`, `babelify`, and `uglify-js`:
 
-  ```
-  $ [sudo] npm install -g browserify babelify uglify-js
-  ```
+```sh
+[sudo] npm install -g browserify babelify uglify-js
+```
 
 - Download or clone the vis.js project:
 
-  ```
-  $ git clone https://github.com/almende/vis.git
-  ```
+```sh
+git clone https://github.com/almende/vis.git
+```
 
 - Install the dependencies of vis.js by running `npm install` in the root of the project:
 
-  ```
-  $ cd vis
-  $ npm install
-  ```
+```sh
+cd vis
+npm install
+```
 
 ### Examples of custom builds
 
@@ -212,11 +203,15 @@ exports.Timeline = require('./lib/timeline/Timeline');
 
 Then create a custom bundle using browserify, like:
 
-    $ browserify custom.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis
+```sh
+browserify custom.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis
+```
 
 This will generate a custom bundle *vis-custom.js*, which exposes the namespace `vis` containing only `DataSet` and `Timeline`. The generated bundle can be minified using uglifyjs:
 
-    $ uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
+```sh
+uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
+```
 
 The custom bundle can now be loaded like:
 
@@ -237,11 +232,15 @@ The custom bundle can now be loaded like:
 
 The default bundle `vis.js` is standalone and includes external dependencies such as *hammer.js* and *moment.js*. When these libraries are already loaded by the application, vis.js does not need to include these dependencies itself too. To build a custom bundle of vis.js excluding *moment.js* and *hammer.js*, run browserify in the root of the project:
 
-    $ browserify index.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis -x moment -x hammerjs
+```sh
+browserify index.js -t [ babelify --presets [es2015] ] -o dist/vis-custom.js -s vis -x moment -x hammerjs
+```
 
 This will generate a custom bundle *vis-custom.js*, which exposes the namespace `vis`, and has *moment.js* and *hammer.js* excluded. The generated bundle can be minified with uglifyjs:
 
-    $ uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
+```sh
+uglifyjs dist/vis-custom.js -o dist/vis-custom.min.js
+```
 
 The custom bundle can now be loaded as:
 
@@ -287,8 +286,10 @@ var timeline = new Timeline(container, data, options);
 
 The application can be bundled and minified:
 
-    $ browserify app.js -o dist/app-bundle.js -t babelify
-    $ uglifyjs dist/app-bundle.js -o dist/app-bundle.min.js
+```sh
+browserify app.js -o dist/app-bundle.js -t babelify
+uglifyjs dist/app-bundle.js -o dist/app-bundle.min.js
+```
 
 And loaded into a webpage:
 
@@ -346,24 +347,26 @@ There is also an [demo-project](https://github.com/mojoaxel/vis-webpack-demo) sh
 
 To test the library, install the project dependencies once:
 
-    $ npm install
+```sh
+npm install
+```
 
 Then run the tests:
 
-    $ npm run test
+```sh
+npm run test
+```
 
 ## License
 
 Copyright (C) 2010-2017 Almende B.V. and Contributors
 
 Vis.js is dual licensed under both
 
-  * The Apache 2.0 License
-    http://www.apache.org/licenses/LICENSE-2.0
+- [The Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0)
 
 and
 
-  * The MIT License
-    http://opensource.org/licenses/MIT
+- [The MIT License](http://opensource.org/licenses/MIT)
 
 Vis.js may be distributed under either license.
diff --git a/misc/how_to_help.md b/misc/how_to_help.md
@@ -1,69 +1,5 @@
-# HowTo Help
+# How to help!
 
-The company that developed vis.js for the main part, *almende* is [not able to maintain the project at the moment](./we_need_help.md). So help from the community is very needed and welcome!
+This project is no longer in active development. See #4259 for details.
 
-## There are many ways to help:
-
-### Answering questions
-
-There are new [issues with questions](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3AQuestion+sort%3Acreated-desc) how to use vis.js opened almost every day. Be part of the community and help answer them!
-
-A better way to ask questions on how to use vis.js is [stackoverflow](https://stackoverflow.com/tags/vis.js). Questions are posed here also and need to be answered by the community. [Please help answering questions](https://stackoverflow.com/tags/vis.js) here also.
-
-### Closing old issues
-
-A new issue is often opened fast and then forgotten. Please help go through [the old issues](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc) (especially the [questions](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+sort%3Acreated-asc+label%3AQuestion)) and ask the creator of the issues if the problem still exists before closing the issue. The support team uses the **issue inactive** label to mark these issues.
-
-### Improve the webpage
-
-The visjs.org webpage is hosted on the [gh-pages branch](//github.com/almende/vis/tree/gh-pages). If you find a typo or anything else that should be improved feel free to create a pull-request to *gh-pages*. Please make changes in your own fork of gh-pages so the support team can view the changes in your hosted fork.
-
-### Create new examples
-
-We have [a collection of examples](//github.com/almende/vis/tree/develop/examples). Please help by creating interesting new ones that show a specific problem or layout. Keep the examples easy to understand for beginners and remove unnecessary clutter.
-
-### Provide interesting showcases
-
-If you use vis.js to develop something beautiful feel free to create a pull-request to our show cases page in the gh-pages branch](//github.com/almende/vis/tree/gh-pages/showcase). [These showcases are displayed on our webpage](http://visjs.org/showcase/index.html) and we are always looking for new examples.
-
-### Confirming and fixing bugs
-
-Every software has bugs. We also have [quite a nice collection](https://github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3ABug+sort%3Areactions-%2B1-desc) ;-)
-Feel free to fix as many bugs as you want!
-
-You can not only help by fixing bugs, but also by confirming the bug or even creating a minimal code example to prove this bug exists.
-
-### Implementing Feature-Requests
-
-A lot of people have a lot of ideas for improving vis.js. [We label these issues as **Feature-Request**](https://github.com/almende/vis/labels/Feature-Request). Feel free to implement a new feature by creating a new Pull-Request.
-
-[Some issues are labeled **For everybody!**](//github.com/almende/vis/issues?q=is%3Aissue+is%3Aopen+label%3A%22For+everyone%21%22+sort%3Areactions-%2B1-desc). These are a good starting point.
-
-### Reviewing Pull-Requests
-
-We use [GitHub's two-step review](//help.github.com/articles/about-pull-request-reviews/) to make sure pull-requests are clean. You can help by checking out pull-request branches and testing them. You also can comment on lines of code and make sure the pull-request introduces no new bugs or typos.
-
-## Creating Pull Requests
-
-There are some rules for pull-request:
-
-* All pull-request must be to the [develop-branch](//github.com/almende/vis/tree/develop). Pull-request against the [master-branch](//github.com/almende/vis/tree/master) must be closed. (Changes to [gh-pages](//github.com/almende/vis/tree/gh-pages) are also ok.)
-
-* Only commit changes done in the source files in the folder `lib`, not to the builds
-  which are located in the folder `dist`.
-
-* Keep your changes small and clear. Only work on one topic at one time and only change lines of code that you have to change to reach your goal.
-
-* Test your changes before creating a pull-request. The easiest way is to open the existing examples and playing with them.
-
-* If you are fixing or implementing an existing issue, please refer to it in the description and in the commit message.
-
-* If you are introducing a new feature, add some documentation and a new example to make it easy to adapt.
-
-* If you introduce breaking changes, like changing the signature of a public function, point that out in your description. Breaking changes result in a new major release.
-
-* Always adapt to the code style of the existing source. Never adapt existing code to your personal taste. :trollface:
-
-* Pull-requests must be reviewed by at least two member of the support team. The First must approve the pull-request, the second can than merge after also checking it.
-
-**Happy Helping!!**
+Please consider contributing to the [visjs community](https://github.com/visjs)!