Skip to content

Commit

Permalink
Update handbook links in doc (sourcegraph#26848)
Browse files Browse the repository at this point in the history
  • Loading branch information
siddhant94 committed Nov 1, 2021
1 parent c5da2ac commit ee6d8e9
Show file tree
Hide file tree
Showing 52 changed files with 931 additions and 932 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/customer_feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ assignees: ''
#### Feedback

<!--
The customer's feedback, filtered of all sensitive information. Links to Chorus/Productboard/Google Docs welcome, but avoid Slack links from Slack channels with a limited retention policy (see https://about.sourcegraph.com/handbook/communication/team_chat#retention).
The customer's feedback, filtered of all sensitive information. Links to Chorus/Productboard/Google Docs welcome, but avoid Slack links from Slack channels with a limited retention policy (see https://handbook.sourcegraph.com/communication/team_chat#retention).
-->

#### Customer
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/request_patch_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ assignees: ''

---

The intent of the questions below is to ensure we keep Sourcegraph high quality and [only create patch releases based on a strict criteria.](https://about.sourcegraph.com/handbook/engineering/releases#when-are-patch-releases-performed) If you can answer yes to many or most of these questions, we will be happy to create the patch release.
The intent of the questions below is to ensure we keep Sourcegraph high quality and [only create patch releases based on a strict criteria.](https://handbook.sourcegraph.com/engineering/releases#patch-releases) If you can answer yes to many or most of these questions, we will be happy to create the patch release.

I have read [when and why we perform patch releases](https://about.sourcegraph.com/handbook/engineering/releases#when-are-patch-releases-performed) and answer the questions as follows:
I have read [when and why we perform patch releases](https://handbook.sourcegraph.com/engineering/releases#patch-releases) and answer the questions as follows:

> Are users/customers actively asking us for these changes and cannot wait until the next full release?
Expand All @@ -41,7 +41,7 @@ I have read [when and why we perform patch releases](https://about.sourcegraph.c

---

**For the [release captain](https://about.sourcegraph.com/handbook/engineering/releases#release-captain)** - after reviewing this request:
**For the [release captain](https://handbook.sourcegraph.com/engineering/releases#release-captain)** - after reviewing this request:

- [ ] **Comment on this issue** with a decision regarding the request.
- [ ] If approved, **add it to a patch release**:
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

In short, we are open to nearly all contributions! We love feedback in all forms, issues, comments, PRs, etc!

Unless you feel confident your change will be accepted (trivial bug fixes, code cleanup, etc) you should first create an issue or a [Sourcegraph RFC](https://about.sourcegraph.com/handbook/communication/rfcs#external-contributors) (preferred for bigger changes) to discuss your change with us. This lets us all discuss the design and proposed implementation of your change, which helps ensure your time is well spent and that your contribution will be accepted.
Unless you feel confident your change will be accepted (trivial bug fixes, code cleanup, etc) you should first create an issue or a [Sourcegraph RFC](https://handbook.sourcegraph.com/communication/rfcs#external-contributors) (preferred for bigger changes) to discuss your change with us. This lets us all discuss the design and proposed implementation of your change, which helps ensure your time is well spent and that your contribution will be accepted.

> Exception: If you contribute functionality that already exists as a [paid Sourcegraph feature](https://about.sourcegraph.com/pricing/), we are unlikely to accept it. Consult us beforehand for a definitive answer. (We'll add more details about the process here, and they'll be similar to [GitLab's stewardship principles](https://about.gitlab.com/stewardship/#contributing-an-existing-ee-feature-to-ce).)
Expand Down Expand Up @@ -44,6 +44,6 @@ All open issues are not yet solved. If the task is interesting to you, take it a
### Pull Requests

- [How to structure](https://docs.sourcegraph.com/dev/background-information/code_reviews#what-makes-an-effective-pull-request-pr)
- [Size guidelines](https://about.sourcegraph.com/handbook/engineering/developer-insights#prefer-small-prs-lines)
- [Size guidelines](https://handbook.sourcegraph.com/engineering/enablement#prefer-small-prs-400-lines)
- Git branch name convention: `[developer-initials]/short-feature-description`
- [Examples on Github](https://github.com/sourcegraph/sourcegraph/pulls?q=is%3Apr+label%3Ateam%2Ffrontend-platform)
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,8 @@ The `doc` directory has additional documentation for developing and understandin
- [Project FAQ](./doc/admin/faq.md)
- [Architecture](./doc/dev/background-information/architecture/index.md): high-level architecture
- [Database setup](./doc/dev/background-information/postgresql.md): database best practices
- [General style guide](https://about.sourcegraph.com/handbook/communication/style_guide)
- [Go style guide](https://about.sourcegraph.com/handbook/engineering/languages/go)
- [Documentation style guide](https://about.sourcegraph.com/handbook/engineering/product_documentation)
- [Go style guide](./doc/dev/background-information/languages/go)
- [Documentation style guide](https://handbook.sourcegraph.com/engineering/product_documentation)
- [GraphQL API](./doc/api/graphql/index.md): useful tips when modifying the GraphQL API
- [Contributing](./CONTRIBUTING.md)

Expand Down
2 changes: 1 addition & 1 deletion client/branded/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This folder contains client code that is **branded**, i.e. it implements the visual design language we use across our web app and e.g. in the options menu of the browser extension.
Code in here can use Bootstrap and must not adapt styles of the code host (for more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling)).
Code in here can use Bootstrap and must not adapt styles of the code host (for more details, see [Styling UI in the handbook](../../doc/dev/background-information/web/styling.md)).

Any code that is code host agnostic should go into [`../shared`](../shared) instead.
2 changes: 1 addition & 1 deletion client/shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ This folder contains common TypeScript/React/SCSS client code shared between the

Everything in this folder is code-host agnostic and cannot make assumptions about whether it is running inside the Sourcegraph web app, in the browser extension on GitHub, Gitlab, Phabricator, Bitbucket Server, etc.
In particular, components cannot make use of Bootstrap classes, but must accept CSS classes as props and/or have their own code host agnostic SCSS stylesheets.
For more details, see [Styling UI in the handbook](https://about.sourcegraph.com/handbook/engineering/web/styling).
For more details, see [Styling UI in the handbook](../../doc/dev/background-information/web/styling.md).

Code that is only used in branded contexts (web app, options menu of the browser extension, ...) should go into [`../branded`](../branded) instead.
2 changes: 1 addition & 1 deletion client/web/src/components/Breadcrumbs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export interface BreadcrumbSetters {
* pass an arbitrary element or a link config object for simpler breadcrumbs.
* @returns Another breadcrumb setters object to pass down to child components to register child breadcrumbs,
* with a method to remove the breadcrumb again. The object should be added to a [subscription
* bag](https://about.sourcegraph.com/handbook/engineering/languages/typescript#subscription-bag).
* bag](https://docs.sourcegraph.com/dev/background-information/languages/typescript#subscription-bag).
*/
setBreadcrumb: (breadcrumb: NullableBreadcrumb) => BreadcrumbSetters & Unsubscribable
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ export const SiteAdminGenerateProductLicenseForSubscriptionForm: React.FunctionC
</datalist>
<small className="form-text text-muted">
Tags restrict a license. Please refer to{' '}
<a href="https://about.sourcegraph.com/handbook/ce/license_keys#how-to-create-a-license-key-for-a-new-prospect-or-new-customer">
<a href="https://handbook.sourcegraph.com/ce/license_keys#how-to-create-a-license-key-for-a-new-prospect-or-new-customer">
How to create a license key for a new prospect or new customer
</a>{' '}
for a complete guide.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ exports[`SiteAdminGenerateProductLicenseForSubscriptionForm renders 1`] = `
Tags restrict a license. Please refer to
<a
href="https://about.sourcegraph.com/handbook/ce/license_keys#how-to-create-a-license-key-for-a-new-prospect-or-new-customer"
href="https://handbook.sourcegraph.com/ce/license_keys#how-to-create-a-license-key-for-a-new-prospect-or-new-customer"
>
How to create a license key for a new prospect or new customer
</a>
Expand Down
2 changes: 1 addition & 1 deletion dev/licenses.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This script either generates a report of third-party dependencies, or runs a check that fails
# if there are any unapproved dependencies ('action items').
#
# Please refer to the handbook entry for more details: https://about.sourcegraph.com/handbook/engineering/continuous_integration#third-party-licenses
# Please refer to the handbook entry for more details: https://docs.sourcegraph.com/dev/background-information/continuous_integration#third-party-licenses

set -euf -o pipefail

Expand Down
2 changes: 1 addition & 1 deletion dev/release/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Sourcegraph release tool

This directory contains scripts and code to automate our releases. Refer to
[the handbook](https://about.sourcegraph.com/handbook/engineering/releases) for details
[the handbook](https://handbook.sourcegraph.com/engineering/releases) for details
on our release process and how this tool is used.

To see all available steps:
Expand Down
2 changes: 1 addition & 1 deletion dev/release/src/batchChanges.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import YAML from 'yaml'
import { CreatedChangeset } from './github'
import { readLine, cacheFolder } from './util'

// https://about.sourcegraph.com/handbook/engineering/deployments/instances#k8s-sgdev-org
// https://handbook.sourcegraph.com/engineering/deployments/instances#k8s-sgdev-org
const DEFAULT_SRC_ENDPOINT = 'https://k8s.sgdev.org'

interface SourcegraphCLIConfig {
Expand Down
2 changes: 1 addition & 1 deletion dev/release/src/release.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ const steps: Step[] = [
description: 'Output help text about this tool',
argNames: ['all'],
run: (_config, all) => {
console.error('Sourcegraph release tool - https://about.sourcegraph.com/handbook/engineering/releases')
console.error('Sourcegraph release tool - https://handbook.sourcegraph.com/engineering/releases')
console.error('\nUSAGE\n')
console.error('\tyarn run release <step>')
console.error('\nAVAILABLE STEPS\n')
Expand Down
4 changes: 2 additions & 2 deletions doc/admin/install/managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ As part of this service you will receive a number of benefits from our team, inc
## Health monitoring, support, and SLAs

- Instance performance and health [monitored](../observability/index.md) by our team's on-call engineers.
- [Responding to support requests and maintaining SLAs](https://about.sourcegraph.com/handbook/ce/support#for-customers-with-managed-instances)
- [Responding to support requests and maintaining SLAs](https://handbook.sourcegraph.com/support#for-customers-with-managed-instances)

## Backup and Restore

Expand Down Expand Up @@ -79,7 +79,7 @@ As with any Sourcegraph enterprise customer, you will also receive support from

Your managed instance will be accessible over HTTPS/TLS, provide storage volumes that are encrypted at rest, and would have access restricted to only your team through your enterprise VPN and/or internal [SSO (single sign-on provider)](../auth/index.md) of choice.

It will be hosted in completely isolated Google Cloud infrastructure, with minimal access even within the Sourcegraph team, both for security and billing purposes. See our [employee handbook](https://about.sourcegraph.com/handbook/engineering/distribution/managed#technical-details) to learn more about the cloud architecture we use. Both your team and limited Sourcegraph personnel will have application-level administrator access to the instance.
It will be hosted in completely isolated Google Cloud infrastructure, with minimal access even within the Sourcegraph team, both for security and billing purposes. See our [employee handbook](https://handbook.sourcegraph.com/engineering/enablement/delivery/managed#technical-details) to learn more about the cloud architecture we use. Both your team and limited Sourcegraph personnel will have application-level administrator access to the instance.

Only essential Sourcegraph personnel will have access to the instance, server, code, and any other sensitive materials, such as tokens or keys. The employees or contractors with access would be bound by the same terms as Sourcegraph itself. Learn more in our [network security policies for Sourcegraph Cloud](https://about.sourcegraph.com/security) or [contact us](https://about.sourcegraph.com/contact/sales) with any questions/concerns.

Expand Down
Loading

0 comments on commit ee6d8e9

Please sign in to comment.