artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 19:21:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
main
sourcegraph/README.md

68 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

Update README.md (#49632) * Removed 4.0 branding * Updated URL ![Screen Recording 2023-03-17 at 01 26 08 PM](https://user-images.githubusercontent.com/398230/226031341-5cb9cec0-1193-4b7e-9603-175ce283f02b.gif) ## Test plan <!-- All pull requests REQUIRE a test plan: https://docs.sourcegraph.com/dev/background-information/testing_principles --> * Test URL * Test dark/light mode
2023-03-17 20:28:21 +00:00
<p align="center">
Update marketing website link in monorepo (#58449) Co-authored-by: Alex Isken <alex.isken@sourcegraph.com> Co-authored-by: Joe Chen <joe@sourcegraph.com>
2023-12-01 22:22:34 +00:00
<a href="https://sourcegraph.com/" target="_blank">
Update README.md (#49632) * Removed 4.0 branding * Updated URL ![Screen Recording 2023-03-17 at 01 26 08 PM](https://user-images.githubusercontent.com/398230/226031341-5cb9cec0-1193-4b7e-9603-175ce283f02b.gif) ## Test plan <!-- All pull requests REQUIRE a test plan: https://docs.sourcegraph.com/dev/background-information/testing_principles --> * Test URL * Test dark/light mode
2023-03-17 20:28:21 +00:00
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://p21.p4.n0.cdn.getcloudapp.com/items/6qub2y6g/8c25cf68-2715-4f0e-9de6-26292fad604f.svg" width="50%">
<img src="https://p21.p4.n0.cdn.getcloudapp.com/items/12u7NWXL/5e21725d-6e84-4ccd-8300-27bf9a050416.svg" width="50%">
</picture></a>
</p>
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
<p align="center">
Docs: update links to point to new site (#60381) We have a number of docs links in the product that point to the old doc site. Method: - Search the repo for `docs.sourcegraph.com` - Exclude the `doc/` dir, all test fixtures, and `CHANGELOG.md` - For each, replace `docs.sourcegraph.com` with `sourcegraph.com/docs` - Navigate to the resulting URL ensuring it's not a dead link, updating the URL if necessary Many of the URLs updated are just comments, but since I'm doing a manual audit of each URL anyways, I felt it was worth it to update these while I was at it.
2024-02-13 00:23:47 +00:00
<a href="https://sourcegraph.com/docs">Docs</a> •
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
<a href="https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CONTRIBUTING.md">Contributing</a> •
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
<a href="https://twitter.com/sourcegraph">Twitter</a> •
<a href="https://discord.gg/s2qDtYGnAE">Discord</a>
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
<br /><br />
<a href="https://buildkite.com/sourcegraph/sourcegraph">
<img src="https://badge.buildkite.com/00bbe6fa9986c78b8e8591cffeb0b0f2e8c4bb610d7e339ff6.svg?branch=main" alt="Build status" />
</a>
<a href="https://api.securityscorecards.dev/projects/github.com/sourcegraph/sourcegraph">
<img src="https://img.shields.io/ossf-scorecard/github.com/sourcegraph/sourcegraph?label=openssf%20scorecard" alt="Scorecard" />
</a>
<a href="https://github.com/sourcegraph/sourcegraph/releases/">
<img src="https://img.shields.io/github/release/sourcegraph/Sourcegraph.svg" alt="Latest release" />
</a>
<a href="https://srcgr.ph/discord">
<img src="https://img.shields.io/discord/969688426372825169?color=5765F2" alt="Discord" />
</a>
<a href="https://github.com/sourcegraph/sourcegraph/contributors/">
<img src="https://img.shields.io/github/contributors/sourcegraph/Sourcegraph.svg?color=000000" alt="Contributors" />
</a>
</p>
<br />
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
**Sourcegraph makes it easy to read, write, and fix code—even in big, complex codebases.**
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
- **Code search:** Search all of your repositories across all branches and all code hosts.
- **Code intelligence:** Navigate code, find references, see code owners, trace history, and more.
- **Fix and refactor:** Roll out large-scale changes to many repositories at once and track big migrations.
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
## Getting started
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
Docs: update links to point to new site (#60381) We have a number of docs links in the product that point to the old doc site. Method: - Search the repo for `docs.sourcegraph.com` - Exclude the `doc/` dir, all test fixtures, and `CHANGELOG.md` - For each, replace `docs.sourcegraph.com` with `sourcegraph.com/docs` - Navigate to the resulting URL ensuring it's not a dead link, updating the URL if necessary Many of the URLs updated are just comments, but since I'm doing a manual audit of each URL anyways, I felt it was worth it to update these while I was at it.
2024-02-13 00:23:47 +00:00
- [Use Sourcegraph on the cloud or self-hosted](https://sourcegraph.com/docs/)
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
- [Sourcegraph.com public code search](https://sourcegraph.com/search)
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
update readme and docs index for 5.0 (#49988)
2023-03-25 03:48:46 +00:00
<br><br>
New README for 4.0 (#41883) * Add 4.0 README draft * Fix formatting issues * Fix formatting * Remove use cases section * Update features * Update URL * Update features section * Add more high-leverage ways to improve * Replace try it now section * Add images
2022-09-30 17:49:04 +00:00
Update marketing website link in monorepo (#58449) Co-authored-by: Alex Isken <alex.isken@sourcegraph.com> Co-authored-by: Joe Chen <joe@sourcegraph.com>
2023-12-01 22:22:34 +00:00
<img src="https://sourcegraph.com/home/banner.png" />
update README
2018-10-01 19:04:55 +00:00
docs: redesign homepage and update admin/install (#22965) - Redesign docs homepage - Use logo and copy market-y intro text from https://about.sourcegraph.com/ - "Quick start guide" is now "Quick install". IMO this is a bit clearer on the intent that the Docker deployment is just for the sake of something that's quick to install, and not really to use. - Remove a lot of the quick install guide that's duplicated from the docker install guide - More prominent note about docker-not-for-production - Sourcegraph Cloud and deployment methods are now much more prominently featured - Update `admin/install` - Feature self-hosted more prominently, reorder the options and add some formatting - Updated tips - A bit of README update
2021-07-19 23:26:30 +00:00
## Development
Update broken link for our Development docs in the README file (#62638) Update the broken link for our Development docs in the README file.
2024-05-13 21:13:45 +00:00
Refer to the [Developing Sourcegraph guide](https://docs-legacy.sourcegraph.com/dev) to get started.
docs: redesign homepage and update admin/install (#22965) - Redesign docs homepage - Use logo and copy market-y intro text from https://about.sourcegraph.com/ - "Quick start guide" is now "Quick install". IMO this is a bit clearer on the intent that the Docker deployment is just for the sake of something that's quick to install, and not really to use. - Remove a lot of the quick install guide that's duplicated from the docker install guide - More prominent note about docker-not-for-production - Sourcegraph Cloud and deployment methods are now much more prominently featured - Update `admin/install` - Feature self-hosted more prominently, reorder the options and add some formatting - Updated tips - A bit of README update
2021-07-19 23:26:30 +00:00
update README
2018-10-01 19:04:55 +00:00
### Documentation
docs: minor fixes to words and links (#8381) * Update index.md * Update index.md * Update README.md * Update local_development.md * Update README.md * Update local_development.md
2020-02-12 17:06:22 +00:00
The `doc` directory has additional documentation for developing and understanding Sourcegraph:
Publish Sourcegraph as open source 🚀 Internal revision: sourcegraph/sourcegraph-intermediate-2018@d0cebbadc708dc53ddddee6753f494214a589b26 Executor: @slimsag
2018-10-01 06:08:12 +00:00
Update links to developer docs in README (#14578)
2020-10-09 20:41:07 +00:00
- [Architecture](./doc/dev/background-information/architecture/index.md): high-level architecture
- [Database setup](./doc/dev/background-information/postgresql.md): database best practices
Fix broken link in README.
2021-11-18 20:43:45 +00:00
- [Go style guide](./doc/dev/background-information/languages/go.md)
Update handbook links in doc (#26848)
2021-11-01 16:09:49 +00:00
- [Documentation style guide](https://handbook.sourcegraph.com/engineering/product_documentation)
Update links to developer docs in README (#14578)
2020-10-09 20:41:07 +00:00
- [GraphQL API](./doc/api/graphql/index.md): useful tips when modifying the GraphQL API
docs: add CONTRIBUTING + open-source FAQ (#178) * add CONTRIBUTING.md + mention conduct from there not in README * docs: add FAQ
2018-10-01 22:10:43 +00:00
- [Contributing](./CONTRIBUTING.md)
enterprise license
2018-10-26 22:58:34 +00:00
docs: redesign homepage and update admin/install (#22965) - Redesign docs homepage - Use logo and copy market-y intro text from https://about.sourcegraph.com/ - "Quick start guide" is now "Quick install". IMO this is a bit clearer on the intent that the Docker deployment is just for the sake of something that's quick to install, and not really to use. - Remove a lot of the quick install guide that's duplicated from the docker install guide - More prominent note about docker-not-for-production - Sourcegraph Cloud and deployment methods are now much more prominently featured - Update `admin/install` - Feature self-hosted more prominently, reorder the options and add some formatting - Updated tips - A bit of README update
2021-07-19 23:26:30 +00:00
## License
enterprise license
2018-10-26 22:58:34 +00:00
remove more remannts of OSS build (#58253) Removes: - doc mentions of OSS build - linters related to OSS/enterprise code - unused `osscmd` package and related definitions
2023-11-10 07:59:03 +00:00
This repository contains primarily non-OSS-licensed files. See [LICENSE](LICENSE).
Add copyright to README (#62468)
2024-05-06 17:48:33 +00:00
Copyright (c) 2018-present Sourcegraph Inc.
Reference in New Issue Copy Permalink