Skip to content

Commit

Permalink
[CARBONDATA-1044] Rename incubator-carbondata to carbondata in docs a…
Browse files Browse the repository at this point in the history
…nd readme This closes #903
  • Loading branch information
chenliang613 committed May 11, 2017
2 parents 4c585db + 51564ce commit 36ecb37
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,27 @@ CarbonData file format is a columnar store in HDFS, it has many features that a
* Supports for various use cases with one single Data format : like interactive OLAP-style query, Sequential Access (big scan), Random Access (narrow scan).

## Building CarbonData
CarbonData is built using Apache Maven, to [build CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build)
CarbonData is built using Apache Maven, to [build CarbonData](https://github.com/apache/carbondata/blob/master/build)

## Online Documentation
* [Quick Start](https://github.com/apache/incubator-carbondata/blob/master/docs/quick-start-guide.md)
* [CarbonData File Structure](https://github.com/apache/incubator-carbondata/blob/master/docs/file-structure-of-carbondata.md)
* [Data Types](https://github.com/apache/incubator-carbondata/blob/master/docs/supported-data-types-in-carbondata.md)
* [Data Management](https://github.com/apache/incubator-carbondata/blob/master/docs/data-management.md)
* [DDL Operations on CarbonData](https://github.com/apache/incubator-carbondata/blob/master/docs/ddl-operation-on-carbondata.md)
* [DML Operations on CarbonData](https://github.com/apache/incubator-carbondata/blob/master/docs/dml-operation-on-carbondata.md)
* [Cluster Installation and Deployment](https://github.com/apache/incubator-carbondata/blob/master/docs/installation-guide.md)
* [Configuring Carbondata](https://github.com/apache/incubator-carbondata/blob/master/docs/configuration-parameters.md)
* [FAQ](https://github.com/apache/incubator-carbondata/blob/master/docs/faq.md)
* [Trouble Shooting](https://github.com/apache/incubator-carbondata/blob/master/docs/troubleshooting.md)
* [Useful Tips](https://github.com/apache/incubator-carbondata/blob/master/docs/useful-tips-on-carbondata.md)
* [Quick Start](https://github.com/apache/carbondata/blob/master/docs/quick-start-guide.md)
* [CarbonData File Structure](https://github.com/apache/carbondata/blob/master/docs/file-structure-of-carbondata.md)
* [Data Types](https://github.com/apache/carbondata/blob/master/docs/supported-data-types-in-carbondata.md)
* [Data Management](https://github.com/apache/carbondata/blob/master/docs/data-management.md)
* [DDL Operations on CarbonData](https://github.com/apache/carbondata/blob/master/docs/ddl-operation-on-carbondata.md)
* [DML Operations on CarbonData](https://github.com/apache/carbondata/blob/master/docs/dml-operation-on-carbondata.md)
* [Cluster Installation and Deployment](https://github.com/apache/carbondata/blob/master/docs/installation-guide.md)
* [Configuring Carbondata](https://github.com/apache/carbondata/blob/master/docs/configuration-parameters.md)
* [FAQ](https://github.com/apache/carbondata/blob/master/docs/faq.md)
* [Trouble Shooting](https://github.com/apache/carbondata/blob/master/docs/troubleshooting.md)
* [Useful Tips](https://github.com/apache/carbondata/blob/master/docs/useful-tips-on-carbondata.md)

## Other Technical Material
[Apache CarbonData meetup material](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=66850609)

## Fork and Contribute
This is an active open source project for everyone, and we are always open to people who want to use this system or contribute to it.
This guide document introduce [how to contribute to CarbonData](https://github.com/apache/incubator-carbondata/blob/master/docs/How-to-contribute-to-Apache-CarbonData.md).
This guide document introduce [how to contribute to CarbonData](https://github.com/apache/carbondata/blob/master/docs/How-to-contribute-to-Apache-CarbonData.md).

## Contact us
To get involved in CarbonData:
Expand Down
8 changes: 4 additions & 4 deletions docs/How-to-contribute-to-Apache-CarbonData.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ $ git config --global user.name "Your Name"

#### Fork the repository on GitHub

Go to the [Apache CarbonData GitHub mirror](https://github.com/apache/incubator-carbondata) and
Go to the [Apache CarbonData GitHub mirror](https://github.com/apache/carbondata) and
fork the repository to your own private account.
This will be your private workspace for staging changes.

Expand All @@ -90,12 +90,12 @@ This will be your private workspace for staging changes.
You are now ready to create the development environment on your local machine.
Clone CarbonData’s read-only GitHub mirror.
```
$ git clone https://github.com/apache/incubator-carbondata.git
$ cd incubator-carbondata
$ git clone https://github.com/apache/carbondata.git
$ cd carbondata
```
Add your forked repository as an additional Git remote, where you’ll push your changes.
```
$ git remote add <GitHub_user> https://github.com/<GitHub_user>/incubator-carbondata.git
$ git remote add <GitHub_user> https://github.com/<GitHub_user>/carbondata.git
```
You are now ready to start developing!

Expand Down
4 changes: 2 additions & 2 deletions docs/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ followed by :

### Procedure

1. [Build the CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build/README.md) project and get the assembly jar from `./assembly/target/scala-2.1x/carbondata_xxx.jar`.
1. [Build the CarbonData](https://github.com/apache/carbondata/blob/master/build/README.md) project and get the assembly jar from `./assembly/target/scala-2.1x/carbondata_xxx.jar`.

2. Copy `./assembly/target/scala-2.1x/carbondata_xxx.jar` to `$SPARK_HOME/carbonlib` folder.

Expand Down Expand Up @@ -90,7 +90,7 @@ To get started with CarbonData : [Quick Start](quick-start-guide.md), [DDL Opera

The following steps are only for Driver Nodes. (Driver nodes are the one which starts the spark context.)

1. [Build the CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build/README.md) project and get the assembly jar from `./assembly/target/scala-2.1x/carbondata_xxx.jar` and copy to `$SPARK_HOME/carbonlib` folder.
1. [Build the CarbonData](https://github.com/apache/carbondata/blob/master/build/README.md) project and get the assembly jar from `./assembly/target/scala-2.1x/carbondata_xxx.jar` and copy to `$SPARK_HOME/carbonlib` folder.

**NOTE**: Create the carbonlib folder if it does not exists inside `$SPARK_HOME` path.

Expand Down
6 changes: 3 additions & 3 deletions docs/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
This tutorial provides a quick introduction to using CarbonData.

## Prerequisites
* [Installation and building CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build).
* [Installation and building CarbonData](https://github.com/apache/carbondata/blob/master/build).
* Create a sample.csv file using the following commands. The CSV file is required for loading data into CarbonData.

```
Expand All @@ -45,7 +45,7 @@ Start Spark shell by running the following command in the Spark directory:
```
./bin/spark-shell --jars <carbondata assembly jar path>
```
**NOTE**: Assembly jar will be available after [building CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build/README.md) and can be copied from `./assembly/target/scala-2.1x/carbondata_xxx.jar`
**NOTE**: Assembly jar will be available after [building CarbonData](https://github.com/apache/carbondata/blob/master/build/README.md) and can be copied from `./assembly/target/scala-2.1x/carbondata_xxx.jar`

In this shell, SparkSession is readily available as `spark` and Spark context is readily available as `sc`.

Expand Down Expand Up @@ -97,7 +97,7 @@ Start Spark shell by running the following command in the Spark directory:
```
./bin/spark-shell --jars <carbondata assembly jar path>
```
**NOTE**: Assembly jar will be available after [building CarbonData](https://github.com/apache/incubator-carbondata/blob/master/build/README.md) and can be copied from `./assembly/target/scala-2.1x/carbondata_xxx.jar`
**NOTE**: Assembly jar will be available after [building CarbonData](https://github.com/apache/carbondata/blob/master/build/README.md) and can be copied from `./assembly/target/scala-2.1x/carbondata_xxx.jar`

**NOTE**: In this shell, SparkContext is readily available as `sc`.

Expand Down

0 comments on commit 36ecb37

Please sign in to comment.