Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
docs: replace Bazel and Intellij documentation with SBT and VSCode (D…
…EV-607) (#2035) * docs: start working on documentation * Update README.md * chore: update mkdocs-related stuff * docs: cleanup * docs: more cleanup * docs: more tidy up * docs: start documenting vscode * docs: document vscode * docs: remove unused images * docs: remove typedoc * docs: update docs makefile * docs: document third party library usage * fix syntax in main.yml * docs: update docs according to review comments * docs: update file path numbering * docs: changes according to review
- Loading branch information
Showing
with
278 additions
and 7,539 deletions.
- +1 −1 .github/workflows/main.yml
- +4 −0 .gitignore
- +5 −21 README.md
- +16 −16 docs/03-apis/api-v1/reading-and-searching-resources.md
- +1 −1 docs/03-apis/api-v2/query-language.md
- +2 −2 docs/03-apis/api-v2/reading-and-searching-resources.md
- +6 −0 docs/05-internals/development/building-and-running.md
- BIN docs/05-internals/development/figures/bazel-UncommentScala.png
- BIN docs/05-internals/development/figures/bazel-buildFile.png
- BIN docs/05-internals/development/figures/bazel-command-config.png
- BIN docs/05-internals/development/figures/bazel-config-setup.png
- BIN docs/05-internals/development/figures/bazel-debug.png
- BIN docs/05-internals/development/figures/bazel-new-config.png
- BIN docs/05-internals/development/figures/bazel-run-config.png
- BIN docs/05-internals/development/figures/bazel-sync.png
- BIN docs/05-internals/development/figures/bazel-workspace.png
- BIN docs/05-internals/development/figures/import-from-sbt.png
- BIN docs/05-internals/development/figures/install-scala-plugin.png
- BIN docs/05-internals/development/figures/intellij-after-import.png
- BIN docs/05-internals/development/figures/launch-visualvm.png
- BIN docs/05-internals/development/figures/sbt-config.png
- BIN docs/05-internals/development/figures/setup_formatting.png
- BIN docs/05-internals/development/figures/visualvm-call-tree.png
- BIN docs/05-internals/development/figures/visualvm-overview.png
- BIN docs/05-internals/development/figures/visualvm-sampler.png
- BIN docs/05-internals/development/figures/visualvm-snapshot-button.png
- BIN docs/05-internals/development/figures/visualvm-snapshot.png
- BIN docs/05-internals/development/figures/vscode-docker.png
- BIN docs/05-internals/development/figures/vscode-metals-test-codelens.png
- BIN docs/05-internals/development/figures/vscode-metals-test.png
- +0 −85 docs/05-internals/development/graphdb.md
- +1 −3 docs/05-internals/development/index.md
- +0 −68 docs/05-internals/development/intellij-config.md
- +0 −8 docs/05-internals/development/migrationNotes.md
- +1 −14 docs/05-internals/development/overview.md
- +0 −23 docs/05-internals/development/profiling.md
- +44 −9 docs/05-internals/development/third-party.md
- +37 −0 docs/05-internals/development/vscode-config.md
- 0 docs/{07-sipi → 06-sipi}/index.md
- 0 docs/{07-sipi → 06-sipi}/setup-sipi-for-dsp-api.md
- 0 docs/{07-sipi → 06-sipi}/sipi-and-dsp-api.md
- 0 docs/{08-lucene → 07-lucene}/index.md
- 0 docs/{08-lucene → 07-lucene}/lucene-query-parser-syntax.md
- +0 −31 docs/Makefile
- +2 −2 docs/index.md
- +24 −3 docs/requirements.txt
- +0 −29 docs/src/api-admin/index.html
- +0 −160 docs/src/api-v1/addValueFormats.ts
- +0 −454 docs/src/api-v1/basicMessageComponents.ts
- +0 −195 docs/src/api-v1/changeValueFormats.ts
- +0 −226 docs/src/api-v1/createResourceFormats.ts
- +0 −43 docs/src/api-v1/deleteResponseFormats.ts
- +0 −78 docs/src/api-v1/graphDataResponseFormats.ts
- +0 −158 docs/src/api-v1/groupFormats.ts
- +0 −100 docs/src/api-v1/hierarchicalListResponseFormats.ts
- +0 −56 docs/src/api-v1/mappingFormats.ts
- +0 −161 docs/src/api-v1/permissionFormats.ts
- +0 −252 docs/src/api-v1/projectFormats.ts
- +0 −760 docs/src/api-v1/resourceResponseFormats.ts
- +0 −19 docs/src/api-v1/sampleRequests/sampleAddValues.ts
- +0 −18 docs/src/api-v1/sampleRequests/sampleChangeValues.ts
- +0 −48 docs/src/api-v1/sampleRequests/sampleCreateResources.ts
- +0 −10 docs/src/api-v1/sampleRequests/sampleDeleteResponses.ts
- +0 −8 docs/src/api-v1/sampleRequests/sampleGraphDataResponse.ts
- +0 −19 docs/src/api-v1/sampleRequests/sampleHierarchicalList.ts
- +0 −126 docs/src/api-v1/sampleRequests/sampleLoginResponse.ts
- +0 −86 docs/src/api-v1/sampleRequests/sampleResourceResponses.ts
- +0 −18 docs/src/api-v1/sampleRequests/sampleValueResponse.ts
- +0 −127 docs/src/api-v1/searchResponseFormats.ts
- +0 −34 docs/src/api-v1/sessionResponseFormats.ts
- +0 −264 docs/src/api-v1/userFormats.ts
- +0 −169 docs/src/api-v1/valueResponseFormats.ts
- +0 −41 docs/src/api-v2/Basic.ts
- +0 −104 docs/src/api-v2/ListResponse.ts
- +0 −67 docs/src/api-v2/MappingFormats.ts
- +0 −146 docs/src/api-v2/ResourcesResponse.ts
- +0 −75 docs/src/api-v2/samples/listResponses.ts
- +0 −22 docs/src/api-v2/samples/mappingMessages.ts
- +0 −2,987 docs/src/api-v2/samples/resourcesResponses.ts
- +134 −138 mkdocs.yml
- +0 −11 test_data/demo_data/image-collection-demo-data-description.md
- +0 −10 test_data/demo_data/incunabula-demo-data-description.md
- +0 −33 test_data/project_shortcodes.md
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
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
@@ -44,3 +44,7 @@ dependencies.txt | ||
metals.sbt | ||
|
||
.tmp/ | ||
|
||
# exclude python virtual environments used for serving docs locally | ||
env/ | ||
venv/ |
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
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
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
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
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
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Deleted file not rendered
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
Oops, something went wrong.