Skip to content

Commit 64c6814

Browse files
author
Sumedh Wale
committed
revamped and enhanced the docs
- switched to mkdocs-material which is much better looking and functional - added custom stylesheet, footer etc for the new theme - updated the mkdocs.yml to use the new theme with customizations, and reorganized it - integrated the SQL functions doc in the top-level reference docs instead of linking to it - removed obsolete docs, resurrected VSD docs (with link to third-party tool) - moved and updated the docs for the new theme - updated and fixed references to Spark version, SnappyData releases and so on - tons of other changes to fix and improve the docs
1 parent d7e9ad6 commit 64c6814

215 files changed

Lines changed: 1312 additions & 993 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ vm_*
1010
.lib/
1111
dist/*
1212
build-artifacts/
13+
site/
1314
lib_managed/
1415
src_managed/
1516
project/boot/

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ When speed is essential, applications can selectively copy the external data int
4646
In SnappyData, operational systems can feed data updates through Kafka to SnappyData. The incoming data can be CDC(Change-data-capture) events (insert, updates, or deletes) and can be easily ingested into in-memory tables with ease, consistency, and exactly-once semantics. The Application can apply custom logic to do sophisticated transformations and get the data ready for analytics. This incremental and continuous process is far more efficient than batch refreshes. Refer [Stream Processing with SnappyData](docs/howto/use_stream_processing_with_snappydata.md) </br>
4747

4848
* **Approximate Query Processing(AQP)** </br>
49-
When dealing with huge data sets, for example, IoT sensor streaming time-series data, it may not be possible to provision the data in-memory, and if left at the source (say Hadoop or S3) your analytic query processing can take too long. In SnappyData, you can create one or more stratified data samples on the full data set. The query engine automatically uses these samples for aggregation queries, and a nearly accurate answer returned to clients. This can be immensely valuable when visualizing a trend, plotting a graph or bar chart. Refer [AQP](docs/aqp.md)
49+
When dealing with huge data sets, for example, IoT sensor streaming time-series data, it may not be possible to provision the data in-memory, and if left at the source (say Hadoop or S3) your analytic query processing can take too long. In SnappyData, you can create one or more stratified data samples on the full data set. The query engine automatically uses these samples for aggregation queries, and a nearly accurate answer returned to clients. This can be immensely valuable when visualizing a trend, plotting a graph or bar chart. Refer [AQP](docs/sde/index.md).
5050

5151
* **Access from anywhere** </br>
5252
You can use JDBC, ODBC, REST, or any of the Apache Spark APIs. The product is fully compatible with Apache Spark 2.1.1. SnappyData natively supports modern visualization tools such as [TIBCO Spotfire](docs/howto/connecttibcospotfire.md), [Tableau](docs/howto/tableauconnect.md), and [Qlikview](docs/setting_up_jdbc_driver_qlikview.md). Refer
5353

5454

5555
## Downloading and Installing SnappyData
5656
You can download and install the latest version of SnappyData from [github](https://github.com/TIBCOSoftware/snappydata/releases).
57-
Refer to the [documentation](docs//install.md) for installation steps.
57+
Refer to the [documentation](docs/install/index.md) for installation steps.
5858

5959
## Getting Started
6060
Multiple options are provided to get started with SnappyData. Easiest way to get going with SnappyData is on your laptop. You can also use any of the following options:
@@ -66,7 +66,7 @@ Multiple options are provided to get started with SnappyData. Easiest way to get
6666
* Docker
6767
* Kubernetes
6868

69-
You can find more information on options for running SnappyData [here](docs/quickstart.md).
69+
You can find more information on options for running SnappyData [here](docs/quickstart/index.md).
7070

7171
## Quick Test to Measure Performance of SnappyData vs Apache Spark
7272

build.gradle

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1540,14 +1540,8 @@ task docs(type: ScalaDoc) {
15401540
destinationDir = file("${rootProject.buildDir}/docs")
15411541
}
15421542

1543-
task buildSqlFuncDocs(type: Exec) {
1544-
dependsOn product
1545-
//on linux
1546-
commandLine "${rootProject.projectDir}/spark/sql/create-docs.sh"
1547-
}
1548-
15491543
task publishDocs(type: Exec) {
1550-
dependsOn docs, buildSqlFuncDocs
1544+
dependsOn product, docs
15511545
//on linux
15521546
commandLine './publish-site.sh'
15531547
}

docs/GettingStarted.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ When speed is essential, applications can selectively copy the external data int
4141
In SnappyData, operational systems can feed data updates through Kafka to SnappyData. The incoming data can be CDC(Change-data-capture) events (insert, updates, or deletes) and can be easily ingested into in-memory tables with ease, consistency, and exactly-once semantics. The Application can apply custom logic to do sophisticated transformations and get the data ready for analytics. This incremental and continuous process is far more efficient than batch refreshes. Refer [Stream Processing with SnappyData](howto/use_stream_processing_with_snappydata.md) </br>
4242

4343
* **Approximate Query Processing(AQP)** </br>
44-
When dealing with huge data sets, for example, IoT sensor streaming time-series data, it may not be possible to provision the data in-memory, and if left at the source (say Hadoop or S3) your analytic query processing can take too long. In SnappyData, you can create one or more stratified data samples on the full data set. The query engine automatically uses these samples for aggregation queries, and a nearly accurate answer returned to clients. This can be immensely valuable when visualizing a trend, plotting a graph or bar chart. Refer [AQP](aqp.md)
44+
When dealing with huge data sets, for example, IoT sensor streaming time-series data, it may not be possible to provision the data in-memory, and if left at the source (say Hadoop or S3) your analytic query processing can take too long. In SnappyData, you can create one or more stratified data samples on the full data set. The query engine automatically uses these samples for aggregation queries, and a nearly accurate answer returned to clients. This can be immensely valuable when visualizing a trend, plotting a graph or bar chart. Refer [AQP](sde/index.md).
4545

4646
* **Access from anywhere** </br>
47-
You can use JDBC, ODBC, REST, or any of the Apache Spark APIs. The product is fully compatible with Apache Spark 2.1.1. SnappyData natively supports modern visualization tools such as [TIBCO Spotfire](howto/connecttibcospotfire.md), [Tableau](howto/tableauconnect.md), and [Qlikview](setting_up_jdbc_driver_qlikview.md). Refer
47+
You can use JDBC, ODBC, REST, or any of the Apache Spark APIs. The product is fully compatible with Apache Spark 2.1.1 to 2.1.3. SnappyData natively supports modern visualization tools such as [TIBCO Spotfire](howto/connecttibcospotfire.md), [Tableau](howto/tableauconnect.md), and [Qlikview](setting_up_jdbc_driver_qlikview.md).
4848

4949

5050
## Downloading and Installing SnappyData
5151
You can download and install the latest version of SnappyData from [github](https://github.com/TIBCOSoftware/snappydata/releases) or you can download the enterprise version that is TIBCO ComputeDB from [here](https://edelivery.tibco.com/storefront/index.ep).
52-
Refer to the [documentation](/install.md) for installation steps.
52+
Refer to the [documentation](install/index.md) for installation steps.
5353

5454
## Getting Started
5555
Multiple options are provided to get started with SnappyData. Easiest way to get going with SnappyData is on your laptop. You can also use any of the following options:
@@ -61,7 +61,7 @@ Multiple options are provided to get started with SnappyData. Easiest way to get
6161
* Docker
6262
* Kubernetes
6363

64-
You can find more information on options for running SnappyData [here](/quickstart.md).
64+
You can find more information on options for running SnappyData [here](quickstart/index.md).
6565

6666
## Quick Test to Measure Performance of SnappyData vs Apache Spark
6767

@@ -132,7 +132,7 @@ For more details, refer [https://github.com/sbt/sbt/issues/3618](https://github.
132132

133133

134134
## Building from Source
135-
If you would like to build SnappyData from source, refer to the [documentation on building from source](/install/building_from_source.md).
135+
If you would like to build SnappyData from source, refer to the [documentation on building from source](install/building_from_source.md).
136136

137137

138138
## How is SnappyData Different than Apache Spark?

docs/Images/logo.png

9.27 KB
Loading

docs/Images/vsd/vsd-connection-stats.png

100755100644
File mode changed.

docs/Images/vsd/vsd_applications.png

100755100644
File mode changed.

docs/Images/vsd/vsd_applications_2.png

100755100644
File mode changed.

docs/Images/vsd/vsd_cpu.png

100755100644
File mode changed.

docs/Images/vsd/vsd_memory.png

100755100644
File mode changed.

0 commit comments

Comments
 (0)