Skip to content

Commit

Permalink
Documentation: provide details about Gradle tasks (#2435)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachelcarmena authored Jun 24, 2021
1 parent c18f3d8 commit d5583f0
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,15 @@ cd arrow-libs
./gradlew buildDoc
```

That Gradle task is equivalent to run Dokka and Ank:

```bash
cd arrow-libs
./gradlew dokka
cd ../arrow-site
./gradlew runAnk
```

### Doc snippets policies

Whenever you are documenting a new type (type class, data type, whatever) you'll wonder how to add code snippets to it. Please,
Expand All @@ -85,6 +94,17 @@ cd arrow-site
./gradlew buildSite
```

That Gradle task is equivalent to run Dokka, Ank and Jekyll build:

```bash
cd arrow-libs
./gradlew dokka
cd ../arrow-site
./gradlew runAnk
bundle install --gemfile Gemfile --path vendor/bundle
bundle exec jekyll serve -s build/site
```

This will install any needed dependencies locally, and will use it to launch the complete website in [127.0.0.1:4000](http://127.0.0.1:4000) so you can open it with a standard browser.

If you get an error while installing the Ruby gem _http_parser_, check if the path to your Arrow directory contains spaces. According to this [issue](https://github.com/tmm1/http_parser.rb/issues/47), the installation with spaces in the path is currently not working.
Expand Down

0 comments on commit d5583f0

Please sign in to comment.