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.

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

Add developer quickstart guide for starting a local server #3382

Merged
merged 3 commits into from
Jan 31, 2023

Conversation

devinrsmith
Copy link
Member

No description provided.

@devinrsmith devinrsmith added documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed. labels Jan 31, 2023
@devinrsmith devinrsmith added this to the Jan 2023 milestone Jan 31, 2023
@devinrsmith devinrsmith self-assigned this Jan 31, 2023
@devinrsmith devinrsmith requested a review from mofojed January 31, 2023 01:16
server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved

```shell
./gradlew server-jetty-app:build
./gradlew server-jetty-app:run -Pgroovy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should mention that these commands are run from the root of the repo, not from this folder.

server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved
server/jetty-app/README.md Outdated Show resolved Hide resolved
```

And then run via:
This produces a more production-like environment.
See [https://deephaven.io/core/docs/how-to-guides/configuration/native-application/](https://deephaven.io/core/docs/how-to-guides/configuration/native-application/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these options not apply in the ./gradlew scenario? Or should the link to this config info be under the Configuration section below?

Copy link
Member Author

@devinrsmith devinrsmith Jan 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's "mostly" equivalent, but there may be differences. The big difference right now is EXTRA_CLASSPATH is not supported.

The other environment variables, which are picked up at runtime, should work (DEEPHAVEN_APPLICATION, DEEPHAVEN_DATA_DIR, DEEPHAVEN_CACHE_DIR, DEEPHAVEN_CONFIG_DIR, and DEEPHAVEN_QUIET).

@devinrsmith devinrsmith requested a review from mofojed January 31, 2023 15:57
@devinrsmith devinrsmith merged commit c0ff305 into deephaven:main Jan 31, 2023
@devinrsmith devinrsmith deleted the local-dev-quickstart branch January 31, 2023 21:08
@github-actions github-actions bot locked and limited conversation to collaborators Jan 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants