Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: provide details about Gradle tasks #2435

Merged
merged 1 commit into from
Jun 24, 2021
+20 −0
Merged

Documentation: provide details about Gradle tasks #2435

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Documentation: provide details about Gradle tasks
@rachelcarmena
rachelcarmena authored Jun 24, 2021
commit 168d9b6c6920b2812c5c95a99fbbdcc82622056f
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -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,
@@ -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.