diff --git a/.prettierignore b/.prettierignore index 52c4c520a0b..eb69a1c455e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -16,3 +16,4 @@ src/schema/ ts-node-* testdata .github/* +doc/dev/roadmap.md diff --git a/doc/dev/roadmap.md b/doc/dev/roadmap.md new file mode 100644 index 00000000000..bfb222df755 --- /dev/null +++ b/doc/dev/roadmap.md @@ -0,0 +1,124 @@ +# Sourcegraph roadmap + +> NOTE: If you're reading this on a Sourcegraph instance's `/help` area, [view the latest roadmap on docs.sourcegraph.com](https://docs.sourcegraph.com/dev/roadmap). + +This roadmap shows what's next for Sourcegraph. The projects and timeframes are subject to change. + +A new Sourcegraph release [ships in the first week of each month](https://about.sourcegraph.com/blog). For example, the October 2018 items will ship in the first week of November 2018. + +We welcome suggestions! Share feedback by using [code discussions](https://about.sourcegraph.com/blog/discuss-code-and-docs-in-repositories) on this document or the linked feature documents. + +## Themes + +We want Sourcegraph to be the best way to answer questions while writing, reviewing, or planning code. See the [Sourcegraph master plan](https://about.sourcegraph.com/plan). Our work generally falls into the following categories: + +- **Search and browsing:** quickly showing you the code you're looking for and making it easy to navigate around +- **Code intelligence:** go-to-definition, hover tooltips, references, symbols, etc., for code in many languages, including real-time and cross-repository support +- **Integrations:** making Sourcegraph work well with code hosts, review tools, editors, and other tools in your dev workflow (e.g., repository syncing from your code host, browser extensions, and editor extensions) +- **Extensibility:** supporting Sourcegraph extensions that add code intelligence and other information (e.g., tracing, logging, and security annotations from 3rd-party tools) to Sourcegraph and external tools that Sourcegraph integrates with +- **Deployment:** making it easy to run and maintain a self-hosted Sourcegraph instance +- **Enterprise:** features that larger companies need (e.g., scaling, authentication, authorization, auditing, etc.) + + + +## October 2018 + +> NOTE: Not all features have their blog posts and docs linked yet. + +Feature | Themes/products | Team +------- | -------- | ---- +[Language support via Sourcegraph extensions](https://sourcegraph.com/github.com/sourcegraph/about/-/blob/projects/simplified-language-support.md) | Code intelligence, extensibility, [Sourcegraph][sourcegraph], [browser extension][browser-extensions], [extension API][sourcegraph-extension-api] | [@chrismwendt][chrismwendt] [@felixfbecker][felixfbecker] +[Sub-query support in search](https://github.com/sourcegraph/about/pull/8) | Search, [Sourcegraph][sourcegraph] | [@keegancsmith][keegancsmith] +Indexed search enabled by default | Search, [Sourcegraph][sourcegraph] | [@keegancsmith][keegancsmith] +Better config and deployment for code host UI integrations | Integrations, [Sourcegraph][sourcegraph], [browser extension][browser-extensions] | [@ijsnow][ijsnow] [@francisschmaltz][francisschmaltz] +Search results from Sourcegraph extensions *(tentative)* | Search, extensibility, [Sourcegraph][sourcegraph], [extension API][sourcegraph-extension-api] | [@attfarhan][attfarhan] +Core product UX | Search and browsing, [Sourcegraph][sourcegraph] | [@vanesa][vanesa] [@francisschmaltz][francisschmaltz] +Unified site config editing and management console | Deployment, [Sourcegraph][sourcegraph], [deploy-sourcegraph][deploy-sourcegraph] | [@ggilmore][ggilmore] +[Repository permissions](https://sourcegraph.com/github.com/sourcegraph/about/-/blob/projects/acls.md) | Enterprise, integrations, [Sourcegraph][sourcegraph] | [@beyang][beyang] +Product documentation | All, [Sourcegraph][sourcegraph] | [@sqs][sqs] +Sourcegraph extensions usage and authoring experience | Extensibility, [Sourcegraph][sourcegraph], [extension API][sourcegraph-extension-api] | [@slimsag][slimsag] [@ryan-blunden][ryan-blunden] + +Release: week of 5 November 2018 --- [All October 2018 issues](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+author%3Asqs+archived%3Afalse+sort%3Aupdated-desc+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fsourcegraph+repo%3Asourcegraph%2Fenterprise+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fbrowser-extensions+repo%3Asourcegraph%2Fextensions-client-common+repo%3Asourcegraph%2Fsrc-cli+repo%3Asourcegraph%2Fcodeintellify+repo%3Asourcegraph%2Fgo-langserver+repo%3Asourcegraph%2Fjavascript-typescript-langserver+repo%3Asourcegraph%2Fjava-langserver+repo%3Asourcegraph%2Fdocs.sourcegraph.com+milestone%3A%22October+2018%22) + +--- + +## November 2018 *(tentative)* + +> NOTE: Not all features have their blog posts and docs linked yet. + +Feature | Themes/products | Team +------- | -------- | ---- +More robust code host repository syncing | Integrations, [Sourcegraph][sourcegraph] | [@keegancsmith][keegancsmith] +[Global public search on Sourcegraph.com](https://github.com/sourcegraph/about/pull/8) *(tentative)* | [Sourcegraph][sourcegraph] | [@keegancsmith][keegancsmith] [@attfarhan][attfarhan] +Standardized code host UI integration points for Sourcegraph extensions | Integrations, [Sourcegraph][sourcegraph], [extension API][sourcegraph-extension-api] [browser extension][browser-extensions] | [@ijsnow][ijsnow] [@chrismwendt][chrismwendt] +Doc site integrations | Integrations, [Sourcegraph][sourcegraph] | [@vanesa][vanesa] [@ijsnow][ijsnow] +Direct UI integration and deployment bundling with GitLab | Integrations, [Sourcegraph][sourcegraph], [browser extension][browser-extensions] | [@ggilmore][ggilmore] [@ijsnow][ijsnow] [@francisschmaltz][francisschmaltz] +JavaScript/TypeScript language support improvements | Code intelligence, sourcegraph-typescript | [@felixfbecker][felixfbecker] +Go language support improvements | Code intelligence, sourcegraph-go | T.B.D. +Python language support improvements (including MyPy) | Code intelligence, sourcegraph-python | T.B.D. +Swift language support | Code intelligence, sourcegraph-swift | T.B.D. ([@nicksnyder][nicksnyder] or [@chrismwendt][chrismwendt]?) +Cross-language API/IDL support ([GraphQL](https://sourcegraph.com/github.com/sourcegraph/about/-/blob/projects/graphql-sourcegraph-extension.md), Thrift, Protobuf) | Code intelligence, sourcegraph-{graphql,thrift,protobuf} | T.B.D +Custom views and panels from Sourcegraph extensions | Extensibility, [Sourcegraph][sourcegraph], [extension API][sourcegraph-extension-api] | [@slimsag][slimsag] [@francisschmaltz][francisschmaltz] + +Release: week of 3 December 2018 --- [All November 2018 issues](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+author%3Asqs+archived%3Afalse+sort%3Aupdated-desc+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fsourcegraph+repo%3Asourcegraph%2Fenterprise+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fbrowser-extensions+repo%3Asourcegraph%2Fextensions-client-common+repo%3Asourcegraph%2Fsrc-cli+repo%3Asourcegraph%2Fcodeintellify+repo%3Asourcegraph%2Fgo-langserver+repo%3Asourcegraph%2Fjavascript-typescript-langserver+repo%3Asourcegraph%2Fjava-langserver+repo%3Asourcegraph%2Fdocs.sourcegraph.com+milestone%3A%22November+2018%22) + +--- + +## December 2018 *(tentative)* + +> NOTE: Not all features have their blog posts and docs linked yet. + +Feature | Themes/products | Team +------- | -------- | ---- +Using Sourcegraph extensions in the editor | Integrations, extensibility, [Sourcegraph][sourcegraph], [extension API][sourcegraph-extension-api] | [@slimsag][slimsag] +Extension registry discovery and statistics | Extensibility, [Sourcegraph][sourcegraph] | [@slimsag][slimsag] [@vanesa][vanesa] [@francisschmaltz][francisschmaltz] +Ruby language support | Code intelligence, sourcegraph-ruby | T.B.D. +Rust language support *(tentative)* | Code intelligence, sourcegraph-go | [@slimsag][slimsag] + +Release: week of 7 January 2019 --- [All December 2018 issues](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+author%3Asqs+archived%3Afalse+sort%3Aupdated-desc+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fsourcegraph+repo%3Asourcegraph%2Fenterprise+repo%3Asourcegraph%2Fsourcegraph-extension-api+repo%3Asourcegraph%2Fbrowser-extensions+repo%3Asourcegraph%2Fextensions-client-common+repo%3Asourcegraph%2Fsrc-cli+repo%3Asourcegraph%2Fcodeintellify+repo%3Asourcegraph%2Fgo-langserver+repo%3Asourcegraph%2Fjavascript-typescript-langserver+repo%3Asourcegraph%2Fjava-langserver+repo%3Asourcegraph%2Fdocs.sourcegraph.com+milestone%3A%22November+2018%22) + +--- + +## January 2019 + +Release: week of 4 February 2019 + +--- + +## February 2019 + +Release: week of 4 March 2019 + +[sourcegraph]: https://github.com/sourcegraph/sourcegraph +[sourcegraph-extension-api]: https://github.com/sourcegraph/sourcegraph-extension-api +[browser-extensions]: https://github.com/sourcegraph/browser-extensions +[deploy-sourcegraph]: https://github.com/sourcegraph/deploy-sourcegraph +[chrismwendt]: https://github.com/chrismwendt +[keegancsmith]: https://github.com/keegancsmith +[vanesa]: https://github.com/vanesa +[attfarhan]: https://github.com/attfarhan +[sqs]: https://github.com/sqs +[beyang]: https://github.com/beyany +[ggilmore]: https://github.com/ggilmore +[ryan-blunden]: https://github.com/ryan-blunden +[francisschmaltz]: https://github.com/francisschmaltz +[ijsnow]: https://github.com/ijsnow +[nicksnyder]: https://github.com/nicksnyder +[dadlerj]: https://github.com/dadlerj +[felixfbecker]: https://github.com/felixfbecker +[slimsag]: https://github.com/slimsag +[kattmingming]: https://github.com/kattmingming + + + diff --git a/doc/index.md b/doc/index.md index 085b8299dd4..8ea9cd354a6 100644 --- a/doc/index.md +++ b/doc/index.md @@ -6,9 +6,9 @@ Sourcegraph development is open source at [github.com/sourcegraph/sourcegraph](h ## For users -The [user documentation](user.md) is about how to use Sourcegraph. The most read docs are: +The [user documentation](user/index.md) is about how to use Sourcegraph. The most read docs are: -- [Overview](user.md): What is Sourcegraph? +- [Overview](user/index.md): What is Sourcegraph? - [Tour](user/tour.md): A walkthrough of Sourcegraph's features, with real-world example use cases. - [Code search](user/search/index.md) - [Integrations](integration/index.md) @@ -17,11 +17,15 @@ The [user documentation](user.md) is about how to use Sourcegraph. The most read ## For site administrators -The [site administration documentation](admin.md) is about deploying and managing a Sourcegraph self-hosted instance. +The [site administration documentation](admin/index.md) is about deploying and managing a Sourcegraph self-hosted instance. ## For contributors to Sourcegraph -See the [contributor documentation](dev.md) and the [main Sourcegraph repository](https://github.com/sourcegraph/sourcegraph) (open-source). +See the [contributor documentation](dev/index.md) and the [main Sourcegraph repository](https://github.com/sourcegraph/sourcegraph) (open-source). + +## Sourcegraph roadmap + +The [Sourcegraph roadmap](dev/roadmap.md) describes what's coming next. ## Sourcegraph subscriptions