From 380718a2624da12c6ae898bec2303b061cc2e9bd Mon Sep 17 00:00:00 2001 From: Eric Fritz Date: Fri, 14 Aug 2020 13:14:05 -0500 Subject: [PATCH] doc/dev: Add code intelligence development documentation (#12949) --- .github/CODEOWNERS | 1 + doc/_resources/templates/document.html | 1 + doc/dev/architecture/architecture.dot | 2 +- doc/dev/architecture/architecture.svg | 2 +- doc/dev/architecture/gen.go | 4 - doc/dev/architecture/generate.sh | 5 + doc/dev/architecture/index.md | 13 +-- .../life-of-a-code-intelligence-query.md | 71 --------------- .../architecture/life-of-an-lsif-upload.md | 28 ------ doc/dev/codeintel/architecture.md | 6 ++ doc/dev/codeintel/deployment.md | 3 + .../diagrams/architecture.dot} | 2 +- .../diagrams/architecture.svg} | 2 +- .../codeintel/diagrams/definitions.mermaid | 34 +++++++ doc/dev/codeintel/diagrams/definitions.svg | 1 + .../diagrams/extension-definitions.mermaid | 25 +++++ .../diagrams/extension-definitions.svg | 1 + .../diagrams/extension-hover.mermaid | 21 +++++ .../codeintel/diagrams/extension-hover.svg | 1 + .../diagrams/extension-references.mermaid | 19 ++++ .../diagrams/extension-references.svg | 1 + doc/dev/codeintel/diagrams/generate.sh | 28 ++++++ doc/dev/codeintel/diagrams/hover.mermaid | 26 ++++++ doc/dev/codeintel/diagrams/hover.svg | 1 + doc/dev/codeintel/diagrams/references.mermaid | 34 +++++++ doc/dev/codeintel/diagrams/references.svg | 1 + .../codeintel/diagrams/resolve-page.mermaid | 53 +++++++++++ doc/dev/codeintel/diagrams/resolve-page.svg | 1 + doc/dev/codeintel/diagrams/upload.mermaid | 34 +++++++ doc/dev/codeintel/diagrams/upload.svg | 1 + doc/dev/codeintel/extensions.md | 85 +++++++++++++++++ doc/dev/codeintel/index.md | 9 ++ doc/dev/codeintel/queries.md | 91 +++++++++++++++++++ doc/dev/codeintel/uploads.md | 48 ++++++++++ doc/dev/index.md | 1 + .../scripts/download.sh | 3 + .../scripts/go-index.sh | 3 - package.json | 7 +- yarn.lock | 22 ++++- 39 files changed, 566 insertions(+), 125 deletions(-) delete mode 100644 doc/dev/architecture/gen.go create mode 100644 doc/dev/architecture/generate.sh delete mode 100644 doc/dev/architecture/life-of-a-code-intelligence-query.md delete mode 100644 doc/dev/architecture/life-of-an-lsif-upload.md create mode 100644 doc/dev/codeintel/architecture.md create mode 100644 doc/dev/codeintel/deployment.md rename doc/dev/{architecture/precise-code-intel.dot => codeintel/diagrams/architecture.dot} (98%) rename doc/dev/{architecture/precise-code-intel.svg => codeintel/diagrams/architecture.svg} (98%) create mode 100644 doc/dev/codeintel/diagrams/definitions.mermaid create mode 100644 doc/dev/codeintel/diagrams/definitions.svg create mode 100644 doc/dev/codeintel/diagrams/extension-definitions.mermaid create mode 100644 doc/dev/codeintel/diagrams/extension-definitions.svg create mode 100644 doc/dev/codeintel/diagrams/extension-hover.mermaid create mode 100644 doc/dev/codeintel/diagrams/extension-hover.svg create mode 100644 doc/dev/codeintel/diagrams/extension-references.mermaid create mode 100644 doc/dev/codeintel/diagrams/extension-references.svg create mode 100755 doc/dev/codeintel/diagrams/generate.sh create mode 100644 doc/dev/codeintel/diagrams/hover.mermaid create mode 100644 doc/dev/codeintel/diagrams/hover.svg create mode 100644 doc/dev/codeintel/diagrams/references.mermaid create mode 100644 doc/dev/codeintel/diagrams/references.svg create mode 100644 doc/dev/codeintel/diagrams/resolve-page.mermaid create mode 100644 doc/dev/codeintel/diagrams/resolve-page.svg create mode 100644 doc/dev/codeintel/diagrams/upload.mermaid create mode 100644 doc/dev/codeintel/diagrams/upload.svg create mode 100644 doc/dev/codeintel/extensions.md create mode 100644 doc/dev/codeintel/index.md create mode 100644 doc/dev/codeintel/queries.md create mode 100644 doc/dev/codeintel/uploads.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 3e60bd99796..2971d9b757d 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -206,6 +206,7 @@ Dockerfile @sourcegraph/distribution /doc/ @sourcegraph/distribution /doc/dev/ @nicksnyder /doc/dev/web/ @felixfbecker @sourcegraph/web +/doc/dev/codeintel/ @efritz @sourcegraph/code-intel # Browser extensions /browser/ @sourcegraph/web diff --git a/doc/_resources/templates/document.html b/doc/_resources/templates/document.html index 779755ecf96..bfc87c5bc18 100644 --- a/doc/_resources/templates/document.html +++ b/doc/_resources/templates/document.html @@ -347,6 +347,7 @@ Developing Sourcegraph