docs(readme): add depreaction message (uber#1302)

micas06gua · Jan 10, 2020 · 0e74ad7 · 0e74ad7
1 parent 712ea62
commit 0e74ad7
Show file tree

Hide file tree

Showing 46 changed files with 134 additions and 36 deletions.
diff --git a/DEPRECATED.md b/DEPRECATED.md
@@ -0,0 +1,5 @@
+# Deprecated
+
+Unfortunately, `react-vis` currently has no active maintainers. As such, we have decided to deprecate the library. This deprecation means that `react-vis` won't receive any patches or new features. If you're interested to take on ownership, please discuss on #1303. Anyone is welcome to fork this library.
+
+We're working on a new charting library that we'll introduce in 2020. We will keep you folks updated on this repo on the new library!
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 <p align="right">
   <a href="https://npmjs.org/package/react-vis">
     <img src="https://img.shields.io/npm/v/react-vis.svg?style=flat-square" alt="version" />

diff --git a/docs/animation.md b/docs/animation.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Animation
 
 Animation makes your charts feel physical, it makes them feel alive, shoot it makes them feel l33t. `react-vis` offers a simple portal into the [react-motion](https://github.com/chenglou/react-motion) animation system by exposing a simple animation prop on most components! This prop accepts three types of values:

diff --git a/docs/arc-series.md b/docs/arc-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## ArcSeries:
 
 <!-- INJECT:"ArcSeriesExampleWithLink" -->

diff --git a/docs/area-series.md b/docs/area-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # AreaSeries
 
 <!-- INJECT:"AreaChartWithLink" -->

diff --git a/docs/axes.md b/docs/axes.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Axes
 
 <!-- INJECT:"CustomAxesOrientationWithLink" -->

diff --git a/docs/bar-series.md b/docs/bar-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Bar Series
 
 **TLDR**: use bar series to make bar charts, but not histograms.
@@ -128,7 +130,7 @@ A list of CSS properties to style the series outside of the explicitly set prope
 
 #### barWidth
 Type: `Number`
-The percentage for which each bar fills the designated bucket. 1.0 means that the bar fills the whole bucket (no padding between bars), while a 
+The percentage for which each bar fills the designated bucket. 1.0 means that the bar fills the whole bucket (no padding between bars), while a
 smaller percentage means more whitespace between the bars.
 
 ## Interaction handlers

diff --git a/docs/borders.md b/docs/borders.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Borders
 
 Sometimes when modifying the domain of the XYPlot it can be useful to enforce a border, so that some components appear, and others do not. One way to do this is to use the `Borders` component. It is a simple component that creates rectangles the directly correspond to the margins of the plot.

diff --git a/docs/chart-label.md b/docs/chart-label.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## ChartLabel
 
 When you are styling your chart sometimes you just want to take complete control of label placements. Maybe you want to annotate something, or maybe you just want to place your axis labels in a very specific place, ChartLabel allows you to do just that. Let's look at an example:

diff --git a/docs/colors.md b/docs/colors.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Color
 
 Color can be set and affected in many ways in React-vis.

diff --git a/docs/contour-series.md b/docs/contour-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## ContourSeries
 
 The contour series allows for the easy creation of contour density plots. These can be more effective for visualizing heat map data than a rectangular heat map! Given a number of points in a space the relative contour lines are computed, so as to simplify the output into a more legible format!

diff --git a/docs/crosshair.md b/docs/crosshair.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Crosshair
 
 <!-- INJECT:"DynamicCrosshairWithLink" -->

diff --git a/docs/custom-svg-series.md b/docs/custom-svg-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## CustomSVGSeries
 
 When creating visualizations, it is sometimes necessary to get your hands dirty and completely take control over what SVG components will be shown. This could be necessary in situations where you have predefined SVG code that you just want to appear the way you drew it in Sketch (but positioned using coordinates), or maybe you have multiline text annotations that you want to formatted in a particular way, or you just want to use an alternative type of mark instead of the usual scatterplot mark to differentiate series in a set. To serve these and many other tasks, we use the CustomSVGSeries.

diff --git a/docs/decorative-axis.md b/docs/decorative-axis.md
@@ -1,3 +1,6 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## DecorativeAxis
 
 <!-- INJECT:"ParallelCoordinatesExampleWithLink" -->

diff --git a/docs/flexible-plots.md b/docs/flexible-plots.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Flexible plots
 
 By default, XYPlot requires a width and a height. There are times, however, when you'd like your chart to take all the space it can.

diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md
@@ -1,8 +1,10 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ### Getting started
 
 #### Jump right in on codepen!
 
-You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent).  
+You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent).
 Each published version of react-vis is accessible via [unpkg.com](https://unpkg.com).
 
 Add react files, and a link to the latest react-vis version - such as https://unpkg.com/[email protected]/dist/dist.min.js.
@@ -11,7 +13,7 @@ But you can simply just use that [pen](https://codepen.io/ubervisualization/pen/
 
 #### Install the react-vis module
 
-If you want to use react-vis in your project, add it from the command line: 
+If you want to use react-vis in your project, add it from the command line:
 
 ```
 npm install react-vis
@@ -22,9 +24,9 @@ npm install react-vis
 #### Create a new project with react-vis
 
 Let's create a new vis app from scratch.
-To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. 
+To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold.
 
-If you haven't installed yet, do so: 
+If you haven't installed yet, do so:
 
 ```
 npm install -g create-react-app
@@ -37,9 +39,9 @@ cd my-awesome-vis-app
 npm install react-vis
 ```
 
-That's it! you are now ready to create amazing charts. 
+That's it! you are now ready to create amazing charts.
 
-Let's edit create-react-app's default App.js: 
+Let's edit create-react-app's default App.js:
 
 ```jsx
 import React, { Component } from 'react';
@@ -80,13 +82,13 @@ and then on the command line interface:
 npm run start
 ```
 
-and your chart is in the browser. 
+and your chart is in the browser.
 
 Note that on line 3, I have imported the react-vis stylesheet. There are many ways to do that, and it is actually optional. But apps made with create-react-app will let you import stylesheets directly, so that's a simple way to do so.
 
 #### Your first chart
 
-We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. 
+We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children.
 
 Every react-vis chart is inside a component called XYPlot, for which a height and a width must be specified:
 

diff --git a/docs/getting-started/installing-react-vis.md b/docs/getting-started/installing-react-vis.md
@@ -1,6 +1,8 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ### Install the react-vis module
 
-If you want to use react-vis in your project, add it from the command line: 
+If you want to use react-vis in your project, add it from the command line:
 
 ```
 npm install react-vis

diff --git a/docs/getting-started/new-react-vis-project.md b/docs/getting-started/new-react-vis-project.md
@@ -1,9 +1,11 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ### Create a new project with react-vis
 
 Let's create a new vis app from scratch.
-To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold. 
+To do this, let's use [create-react-app](https://github.com/facebookincubator/create-react-app), the popular Facebook scaffold.
 
-If you haven't installed yet, do so: 
+If you haven't installed yet, do so:
 
 ```
 npm install -g create-react-app
@@ -16,9 +18,9 @@ cd my-awesome-vis-app
 npm install react-vis
 ```
 
-That's it! you are now ready to create amazing charts. 
+That's it! you are now ready to create amazing charts.
 
-Let's edit create-react-app's default App.js: 
+Let's edit create-react-app's default App.js:
 
 ```jsx
 import React, { Component } from 'react';
@@ -59,6 +61,6 @@ and then on the command line interface:
 npm run start
 ```
 
-and your chart is in the browser. 
+and your chart is in the browser.
 
 Note that on line 3, I have imported the react-vis stylesheet. There are many ways to do that, and it is actually optional. But apps made with create-react-app will let you import stylesheets directly, so that's a simple way to do so.
diff --git a/docs/getting-started/react-vis-in-codepen.md b/docs/getting-started/react-vis-in-codepen.md
@@ -1,6 +1,8 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ### Jump right in on codepen!
 
-You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent).  
+You can use react-vis directly on [codepen](https://codepen.io/ubervisualization/pen/BZOeZB) (or equivalent).
 Each published version of react-vis is accessible via [unpkg.com](https://unpkg.com).
 
 Add react files, and a link to the latest react-vis version - such as https://unpkg.com/[email protected]/dist/dist.min.js.

diff --git a/docs/getting-started/your-first-chart.md b/docs/getting-started/your-first-chart.md
@@ -1,6 +1,8 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ### Your first chart
 
-We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children. 
+We tried to make react-vis syntax as close to the traditional react syntax. You have components which have props and possibly children.
 
 Every react-vis chart is inside a component called XYPlot, for which a height and a width must be specified:
 

diff --git a/docs/gradients.md b/docs/gradients.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Gradient
 
 Sometimes it is useful to style our svg components using gradients. The way that this is done in React-vis is by making use of the GradientDefs component, which is a simple wrapper on the svg <defs> tag.

diff --git a/docs/grids.md b/docs/grids.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Cartesian Grids
 
 <!-- INJECT:"CustomAxisChartWithLink" -->

diff --git a/docs/heatmap-series.md b/docs/heatmap-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## HeatmapSeries:
 
 <!-- INJECT:"HeatmapChartWithLink" -->

diff --git a/docs/hexbin-series.md b/docs/hexbin-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## HexbinSeries
 
 The hexbin series enables the easy creation of aggregated and binned data. This can be useful if you have a lot of overlapping data or if you simply want to provide a courser representation of data to your user. Unlike many other series this one performs the aggregation computation, simply provide a scatterplot like collection of data (points in linear x and y space) and your off!

diff --git a/docs/highlight.md b/docs/highlight.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Highlight
 
 The highlight component enables use interaction via direct manipulation of chart through dragging and brushing. This component is stateful and can maintain a notion of a dragged box. It can be applied either in two directions or in one!

diff --git a/docs/hint.md b/docs/hint.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Hint
 
 <!-- INJECT:"DynamicComplexEdgeHintsWithLink" -->

diff --git a/docs/interaction.md b/docs/interaction.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Interaction
 
 Interaction in react-vis happens through _event handlers_ which are triggered by certain interactive events, such as mouse movement or clicks.

diff --git a/docs/label-series.md b/docs/label-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## LabelSeries:
 
 <!-- INJECT:"LabelSeriesExampleWithLink" -->

diff --git a/docs/legends.md b/docs/legends.md
@@ -1,3 +1,6 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## Legends
 
 <!-- INJECT:"HorizontalDiscreteColorLegendExampleWithLink" -->

diff --git a/docs/line-mark-series.md b/docs/line-mark-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # LineMarkSeries
 
 The Line Mark series is a combination of a LineSeries and a MarkSeries: under the hood, it creates both a LineSeries and a MarkSeries and passes them all of its properties.

diff --git a/docs/line-series.md b/docs/line-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # LineSeries/LineMarkSeries
 
 <!-- INJECT:"LineChartWithLink" -->

diff --git a/docs/mark-series.md b/docs/mark-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## MarkSeries & MarkSeriesCanvas
 
 <!-- INJECT:"ScatterplotChartWithLink" -->

diff --git a/docs/parallel-coordinates.md b/docs/parallel-coordinates.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Parallel Coordinates
 
 Parallel Coordinates provide a robust method for displaying many variables simultaneously. It allows for rapid at-a-glance comparisons across a bunch of dimensions. These graphics can effectively be used either with several data rows on a single chart (as below) or as a small multiple. For more information, check out the [Wiki](https://en.wikipedia.org/wiki/Parallel_coordinates), it's got some really neat examples.

diff --git a/docs/polygon-series.md b/docs/polygon-series.md
@@ -1,3 +1,6 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 ## PolygonSeries:
 
 <!-- INJECT:"TriangleExampleWithLink" -->

diff --git a/docs/radar-chart.md b/docs/radar-chart.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Radar Charts
 
 Radar charts provide a cute method for displaying many variables simultaneously. It allows for rapid at-a-glance comparisons across a bunch of dimensions. These graphics can effectively be used either with several data rows on a single chart (as below) or as a small multiple. For more information, check out the [Wiki](https://en.wikipedia.org/wiki/Radar_chart), it's got some really neat examples.
@@ -156,7 +158,7 @@ Type: `function(d, {event})`
 
 #### onValueMouseOut (optional)
 Type: `function(d, {event})`
-`mouseout` event handler for the elements corresponding separate data points. First argument received is, `d`, the relevant data point, and second an object with the only `event` property.  
+`mouseout` event handler for the elements corresponding separate data points. First argument received is, `d`, the relevant data point, and second an object with the only `event` property.
 
 #### onSeriesMouseOver (optional)
 Type: `function(d, {event})`

diff --git a/docs/radial-chart.md b/docs/radial-chart.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Radial chart
 
 `RadialChart` is responsible for creating pie and donut charts. While this kind of chart is easy to overlook as insignificant, intentionally confusing, or almost always replaceable with a treemap; they can be useful for quickly showing small groups. People don't understand angles very well [(such is our biology)](https://www.interaction-design.org/literature/book/the-encyclopedia-of-human-computer-interaction-2nd-ed/data-visualization-for-human-perception), but over the last hundred years we have seen a lot of pie charts! This has caused us to become intimately familiar with them.

diff --git a/docs/rect-series.md b/docs/rect-series.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Rect Series
 
 RectSeries is a generalization of [BarSeries](bar-series.md) which allows users to build a series of rectangles of arbitrary dimensions. Whereas in barSeries, one dimension of the bars is fixed (width for vertical bar series, height for horizontal bar series), in RectSeries, both dimensions can be controlled.

diff --git a/docs/sankey.md b/docs/sankey.md
@@ -1,3 +1,5 @@
+> This library is deprecated. Please see `DEPRECATED.md`.
+
 # Sankey
 
 Sankey diagrams are a form of graph that allows for the easy communication of flows and other transferal processes.