Skip to content

Commit

Permalink
doc: update (#859)
Browse files Browse the repository at this point in the history
Signed-off-by: frank-zsy <[email protected]>
  • Loading branch information
frank-zsy authored Jun 6, 2022
1 parent fccf61c commit bcc556c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ For study purpose, you can checkout the Clickhouse demo notebook

We use [GHArchive](https://www.gharchive.org/) as our data source for GitHub event logs and the data service is provided by [clickhouse](https://clickhouse.tech/) cluster cloud service. For data details, please check the [data](https://github.com/X-lab2017/open-digger/blob/master/docs/data.md) docs.

### Sample Data Usage

OpenDigger provides ClickHouse sample data and Jupyter notebook image to run OpenDigger in local environment, please refer to [sample data doc](./sample_data/README.md).

## Communication

Welcome to join the WeChat group by scanning the QRCode and I will invite you into our WeChat group.
Expand Down
6 changes: 4 additions & 2 deletions sample_data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ To use the sample data, at minimum 3 GB memory should be allocated to the contai

### ClickHouse server image

x86: `docker pull xlab-registry.cn-shanghai.cr.aliyuncs.com/opendigger/open-digger-clickhouse-base:v1`
Arm: `docker pull xlab-registry.cn-shanghai.cr.aliyuncs.com/opendigger/open-digger-clickhouse-base-arm:v1`
- x86: `docker pull docker-hub.x-lab.info/opendigger/open-digger-clickhouse-base:v1`
- ARM: `docker pull docker-hub.x-lab.info/opendigger/open-digger-clickhouse-base-arm:v1`

### Use Notebook image

## Create sample data

Expand Down

0 comments on commit bcc556c

Please sign in to comment.