This is an automated email from the ASF dual-hosted git repository. warren pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 86bcee8f89ae7473c718a410d0a997c4c25aaccc Author: Mr.An <[email protected]> AuthorDate: Sat May 21 01:42:33 2022 +0800 improve apache devlake website documentation --- README.md | 27 ++++++++++++++++++++++----- docs/02-QuickStart/04-DeveloperSetup.md | 2 +- docs/03-Plugins/refdiff.md | 8 ++++++-- 3 files changed, 29 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index fb729db..160b467 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,31 @@ -# DevLake Website +# Apache DevLake Website -Welcome to visit the [DevLake website](https://devlake.io/)! +This project keeps all sources used for building up DevLake's official website which is served at https://devlake.apache.org/. + +## Prerequisite + + +Please also make sure your node version is 10+, version lower than 10.x is not supported yet. ## Installation -1. In your command line tool, go to this directory and run `yarn`. +1. Run `yarn install` or `yarn` in the root directory to install the dependencies. +2. Run `yarn start` in the root directory to start a local server, you will see the website in 'http://localhost:3000'. + +If you have higher version of node installed, you may consider `nvm` to allow different versions of `node` coexisting on your machine. + +1. Follow the [instructions](http://nvm.sh) to install nvm +2. Run `nvm install v10.23.1` to install node v10 +3. Run `nvm use v10.23.1` to switch the working environment to node v10 -2. Run `yarn start` and your browser will open at http://localhost:3000. To run on a different port, run `yarn start -- -- port xxxx`. +## How to send a PR +1. Do not use `git add .` to commit all the changes. +2. Just push your changed files, such as: + * `*.md` + * blog.js or docs.js or site.js +3. Send a PR to **main** branch. ## Blog Submission -We'd love to hear your thoughts both in creating and using DevLake! To submit a blog post to DevLake Blog, please follow the instructions [here](https://www.devlake.io/community//BlogSubmission). \ No newline at end of file +We'd love to hear your thoughts both in creating and using DevLake! To submit a blog post to DevLake Blog, please follow the instructions [here](https://www.devlake.io/community//BlogSubmission). diff --git a/docs/02-QuickStart/04-DeveloperSetup.md b/docs/02-QuickStart/04-DeveloperSetup.md index 61145b5..4ebd4a7 100644 --- a/docs/02-QuickStart/04-DeveloperSetup.md +++ b/docs/02-QuickStart/04-DeveloperSetup.md @@ -64,7 +64,7 @@ description: > A: Make sure your program find `libgit2.so.1.3`. `LD_LIBRARY_PATH` can be assigned like this if your `libgit2.so.1.3` is located at `/usr/local/lib`: ```sh - export LD_LIBRARY_PATH=/usr/local/lib + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib ``` 8. Visit config UI at `localhost:4000` to configure data connections. diff --git a/docs/03-Plugins/refdiff.md b/docs/03-Plugins/refdiff.md index 25be3ba..294aca8 100644 --- a/docs/03-Plugins/refdiff.md +++ b/docs/03-Plugins/refdiff.md @@ -84,8 +84,12 @@ make make install ``` -### MacOs - +### MacOS +1. HomeBrew install +``` +brew install libgit2 +``` +2. Source install ``` brew install cmake git clone https://github.com/libgit2/libgit2.git
