-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README to include forking workflow * Issue templates for Deephaven Community Documentation * Update README.md * Move notebook request elsewhere * Copy over core docs to legacy folder * Add license * Add Chip to snapshots * Remove legacy docs which will be a new PR for easier review * Update license page * Update README and Style Guide * Update license with full text and move style guide --------- Co-authored-by: margaretkennedy <margaretkennedy@deephaven.io>
- Loading branch information
1 parent
fcb2175
commit 33b8092
Showing
15 changed files
with
816 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Prettier fixes (#3001) | ||
0cab76568b8713f157fd216a4bd4aaee74eab308 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
*.png filter=lfs diff=lfs merge=lfs -text | ||
*.gif filter=lfs diff=lfs merge=lfs -text | ||
*.jpg filter=lfs diff=lfs merge=lfs -text | ||
*.mp4 filter=lfs diff=lfs merge=lfs -text | ||
*.pdf filter=lfs diff=lfs merge=lfs -text | ||
*.zip filter=lfs diff=lfs merge=lfs -text |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Note: there seems to be a lot of contention about the usefulness of CODEOWNERS. | ||
# We should make sure to have a discussion before making code owners more widespread, as it | ||
# potentially causes a lot of extra noise for developers. | ||
# | ||
# See https://about.sourcegraph.com/blog/a-different-way-to-think-about-code-ownership/ | ||
# See https://bionic.fullstory.com/taming-github-codeowners-with-bots/ | ||
|
||
# We want to make sure any changes to workflows are closely monitored, as they may have non-obvious | ||
# security implications. | ||
# | ||
# See https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ | ||
|
||
/.github/ @chipkent @dsmmcken @AlSpinks @mattrunyon | ||
/.vscode @chipkent @dsmmcken | ||
|
||
/src/**/*.js @dsmmcken @chipkent @mofojed @mattrunyon | ||
/*.json @dsmmcken @chipkent @mofojed @mattrunyon | ||
*.css @dsmmcken @chipkent @mofojed @mattrunyon | ||
*.scss @dsmmcken @chipkent @mofojed @mattrunyon | ||
|
||
/core/**/*.md @margaretkennedy @pete-petey @jjbrosnan @chipkent | ||
/static/snapshots @margaretkennedy @pete-petey @jjbrosnan @chipkent | ||
|
||
CONTRIBUTING.md @chipkent @dsmmcken @margaretkennedy | ||
README.md @chipkent @dsmmcken @margaretkennedy | ||
|
||
CODE_OF_CONDUCT.md @chipkent | ||
LICENSE.md @chipkent |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: UPDATE - update request | ||
about: Identify inaccurate information | ||
labels: documentation, update, triage | ||
--- | ||
|
||
<!-- Please read our Code of Conduct: https://github.com/deephaven/deephaven-core/blob/main/CODE_OF_CONDUCT.md --> | ||
<!-- Please search existing issues to avoid creating duplicates. --> | ||
|
||
**Description** | ||
|
||
A clear and concise description of the correction that needs to be made. Please reference the applicable page(s). Is this a typo, or an update due to new a feature? | ||
|
||
**Product** | ||
|
||
[Community] or [Core+] | ||
|
||
**Additional details and attachments** | ||
|
||
Add any additional screenshots or other attachments that may be relevant. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: USER GUIDE - user guide request | ||
about: Suggest a topic to cover in the Deephaven Core documentation | ||
labels: documentation, commmunity, user guide, triage | ||
--- | ||
|
||
<!-- Please read our Code of Conduct: https://github.com/deephaven/deephaven-core/blob/main/CODE_OF_CONDUCT.md --> | ||
<!-- Please search existing issues to avoid creating duplicates. --> | ||
|
||
**Description** | ||
|
||
Describe the content you'd like. | ||
|
||
What specific problem would you like answered? | ||
|
||
**Product** | ||
|
||
[Community] or [Core+] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: VIDEO - video request | ||
about: Suggest a video to include in the Deephaven content collection | ||
labels: documentation, video, triage | ||
--- | ||
|
||
<!-- Please read our Code of Conduct: https://github.com/deephaven/deephaven-core/blob/main/CODE_OF_CONDUCT.md --> | ||
<!-- Please search existing issues to avoid creating duplicates. --> | ||
|
||
**Description** | ||
|
||
Describe the content you'd like. What would you like to see us discuss? | ||
|
||
Will this video be a: | ||
|
||
How-To | ||
Example use case | ||
Deephaven capability | ||
|
||
What is the intended audience for this post? (a technical audience / general audience). | ||
|
||
**Category** | ||
|
||
This contents belongs in: Video section / YouTube. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# | ||
# A GitHub Action to manage Contributor License Agreement (CLA) compliance. | ||
# This action uses CLA Assistant (https://github.com/marketplace/actions/cla-assistant-lite) to ensure that | ||
# all contributors have signed the Deephaven CLA before their PRs are merged. | ||
# The CLA can be signed by commenting on the PR. | ||
# | ||
# The CLA and all signatures are maintained at: https://github.com/deephaven/cla | ||
# | ||
|
||
name: "CLA Assistant" | ||
on: | ||
issue_comment: | ||
types: [created] | ||
pull_request_target: | ||
types: [opened,closed,synchronize] | ||
|
||
jobs: | ||
CLAssistant: | ||
runs-on: ubuntu-22.04 | ||
if: ${{ github.repository_owner == 'deephaven' }} | ||
steps: | ||
- name: "CLA Assistant" | ||
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' | ||
uses: cla-assistant/github-action@v2.1.3-beta | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_PERSONAL_ACCESS_TOKEN }} | ||
with: | ||
path-to-document: 'https://github.com/deephaven/cla/blob/main/CLA.md' | ||
remote-organization-name: deephaven | ||
remote-repository-name: cla | ||
branch: 'main' | ||
path-to-signatures: 'signatures/version1/cla.json' | ||
allowlist: dependabot[bot] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
**/*Zone.Identifier | ||
.idea | ||
*.iml | ||
|
||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/extensions.json | ||
!.vscode/*.code-snippets | ||
|
||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
tools/extract-examples/ |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Dependencies | ||
node_modules | ||
|
||
# Production | ||
build | ||
static | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
# The version log tables become really ugly from prettier spacing columns to max-width | ||
**/reference/version-logs/* | ||
|
||
# Misc | ||
.DS_Store | ||
**/*Zone.Identifier | ||
.idea | ||
*.iml | ||
|
||
.vscode | ||
|
||
npm-debug.log* | ||
|
||
tools/run-examples/*/** | ||
|
||
.github | ||
package.json | ||
package-lock.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"recommendations": [ | ||
"esbenp.prettier-vscode", | ||
"znck.grammarly", | ||
"eamodio.gitlens", | ||
"github.vscode-pull-request-github", | ||
"wayou.vscode-todo-highlight" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"editor.formatOnSave": true, | ||
"editor.tabSize": 2, | ||
"editor.defaultFormatter": "esbenp.prettier-vscode" | ||
} |
Oops, something went wrong.