Deephaven Community Core documentation

Source code for the deephaven.io Community User Guide. This documentation is built using Docusaurus 2, a modern static website generator (powered by React).

Getting the source

Deephaven uses the Forking Workflow. In this workflow, the deephaven/deephaven-community-docs repository contains a minimum number of branches, and development work happens in user-forked repositories.

To learn more see:

• Forking Workflow
• Forking Projects
• Fork A Repo
• Working With Forks

To get started quickly:

1. Navigate to https://github.com/deephaven/deephaven-community-docs.
2. Click Fork in the top right corner.

Installation

GitHub LFS

The repository uses GitHub large file support. Follow the directions in the link to install. If you are using Mac, you need to:

brew install git-lfs
git lfs install

The current files that are stored in LFS can be seen in .gitattributes. To add a new file type to LFS, use the lfs track command.
Here is an example for *.mp4 files.

git lfs track "*.mp4"

Note that if you have installed lfs after you cloned the repo, you will need to manually fetch the lfs files using

git lfs fetch

On some systems, you may also need to run:

git lfs pull

Git Clone

Be sure that GitHub LFS is installed before cloning, or you will just see links to files, instead of the files.

git clone git@github.com:<username>/<forkname>.git

Commit changes to your own branches in your forked repository.

Code Of Conduct

This project has adopted the Contributor Covenant Code of Conduct. For more information see the Code of Conduct or contact opencode@deephaven.io with any additional questions or comments.