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

Jump to bottom

Remove job versioning endpoint on API docs #615

Merged
merged 2 commits into from
Aug 27, 2019
Merged

Remove job versioning endpoint on API docs #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
331dc5d
Remove job versioning endpoint on API docs
wslulciuc Aug 27, 2019
e1347c1
Merge branch 'master' into feature/remove-job-version-endpoint-openapi
wslulciuc Aug 27, 2019
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
23 changes: 21 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We use [spotless](https://github.com/diffplug/spotless) to format our code. This
$ ./gradlew spotlessApply
```

> **Note:** To make formatting code simple, we recommend installing a [plugin](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides) for your favorite IDE. We also us [Lombok](https://projectlombok.org). Though not required, you might want to install the [plugin](https://projectlombok.org/setup/overview) as well.
> **Note:** To make formatting code simple, we recommend installing a [plugin](https://github.com/google/google-java-format#intellij-android-studio-and-other-jetbrains-ides) for your favorite IDE. We also us [Lombok](https://projectlombok.org). Though not required, you might want to install the [plugin](https://projectlombok.org/setup/overview) as well.

# Submitting a [Pull Request](https://help.github.com/articles/about-pull-requests)

Expand All @@ -58,7 +58,26 @@ To ensure your pull request is accepted, follow these guidelines:
* All changes should be accompanied by tests
* Do your best to have a [well-formed commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for your change
* [Keep diffs small](https://graysonkoonce.com/stacked-pull-requests-keeping-github-diffs-small) and self-contained
* If your change fixes a bug, please [link the issue](https://help.github.com/articles/closing-issues-using-keywords) in your pull request description
* If your change fixes a bug, please [link the issue](https://help.github.com/articles/closing-issues-using-keywords) in your pull request description
* Any changes to the API reference requires [regenerating](#docs) the static `openapi.html` file.

# [Docs](https://github.com/MarquezProject/marquez/tree/master/docs)

> **Note:** To bundle or serve the API reference, please install [`redoc-cli`](https://www.npmjs.com/package/redoc-cli).

To bundle:

```bash
$ redoc-cli bundle docs/openapi.yml -o docs/openapi.html --title "Marquez API Reference"
```

To serve:

```bash
$ redoc-cli serve docs/openapi.yml
```

Then browse to: http:https://localhost:8080

# Resources

Expand Down
Loading