Skip to content

Commit 71bb3f7

Browse files
bobheadxibobheadxi
authored
customer-facing beta and experimental policy (#1726)
Adaptation of https://docs.google.com/document/d/15bVl9QBs4aJiJlmiqhGIt8ZMUb9G9dYLpVpqSSo4Rf8/edit?tab=t.aw66tktynwlv for external reference. Minor deviation being discussed here: https://sourcegraph.slack.com/archives/C0AFZSM5RU2/p1774900987314169?thread_ts=1774028164.914529&cid=C0AFZSM5RU2 **Preview: https://sourcegraph-docs-git-beta-and-experimental-sourcegraph-f8c71130.vercel.app/beta-and-experimental**
1 parent 32b853a commit 71bb3f7

File tree

7 files changed

+83
-59
lines changed

7 files changed

+83
-59
lines changed

‎docs/admin/beta-and-experimental-features.mdx‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎docs/admin/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Sourcegraph administration is primarily managed by site administrators, who are
1313
## Features
1414

1515
- [Batch Changes](/batch-changes/)
16-
- [Beta and experimental features](/admin/beta-and-experimental-features)
16+
- [Beta and experimental features](/beta-and-experimental)
1717
- [Code navigation](/code-navigation/)
1818
- [Pings](/admin/pings)
1919
- [Telemetry](/admin/telemetry)

‎docs/admin/repo/perforce.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ We are actively working to significantly improve Sourcegraph's Perforce support.
300300

301301
## Configure experimental features
302302

303-
As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/admin/beta-and-experimental-features#experimental-features).
303+
As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/beta-and-experimental#experimental-features).
304304

305305
### Changelist ID in URLs
306306

‎docs/beta-and-experimental/index.mdx‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Beta and experimental features
2+
3+
**Beta** and **Experimental** Sourcegraph features give you an opportunity to try newer features and shape their development, before they become generally available.
4+
5+
Your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can email us directly to [feedback@sourcegraph.com](mailto:feedback@sourcegraph.com).
6+
7+
For both features labeled **Beta** or **Experimental**, Sourcegraph wants to be transparent that:
8+
9+
- The feature is undergoing active development and your [feedback](mailto:feedback@sourcegraph.com) is especially appreciated
10+
- The feature may have bugs, and is excluded from our support SLAs
11+
- The feature may change, be deprecated, be removed, or be disabled at any time
12+
- The feature may have temporary usage limits during the beta and experimental period.
13+
- The feature may require admin enablement or other intentional setup
14+
- The feature may become [billable with credits](#credits-and-billing) once they become generally available
15+
16+
## Feature lifecycle
17+
18+
Features generally move through the following stages:
19+
20+
| Stage | Label | Credit impact |
21+
| -------------------------------------- | ---------------- | ------------------------------------------------------------------------------ |
22+
| [Experimental](#experimental-features) | **Experimental** | No credits consumed |
23+
| [Beta](#beta-features) | **Beta** | No credits consumed |
24+
| General availability | No special label | [Credits may apply according to the published rate card](#credits-and-billing) |
25+
26+
## Experimental features
27+
28+
If a feature is labeled **Experimental**, this specifically means:
29+
30+
- The feature is intended for early evaluation and will generally require deliberate enablement
31+
- There may be no fixed timeline for moving the feature to **Beta** or general availability
32+
- Some **Experimental** features may have credit costs associated with them when they exit Beta into general availability; see [credits and billing](#credits-and-billing)
33+
- Admins can disable **Experimental** features globally
34+
35+
General points about [both beta and experimental features](#beta-and-experimental-features) also apply.
36+
37+
## Beta features
38+
39+
If a feature is labeled **Beta**, this specifically means:
40+
41+
- The feature may be widely available to all customers by default
42+
- There may be no fixed timeline for moving the feature to general availability
43+
- Some **Beta** features may have credit costs associated with them when they graduate to general availability; see [credits and billing](#credits-and-billing)
44+
- Admins can disable **Beta** features globally
45+
46+
General points about [both beta and experimental features](#beta-and-experimental-features) also apply.
47+
48+
## Credits and billing
49+
50+
Billing depends on the feature.
51+
52+
- **Experimental** and **Beta** features do _not_ consume credits
53+
- Some **Beta** or **Experimental** features, when they graduate to general availability, may be billable with credits.
54+
- Such features will have a **Beta** stage with messaging that identifies, if applicable, the upcoming credit cost and start date. Sourcegraph will provide at least 30 days notice before credits consumption begins.
55+
- Admins can [configure limits](/admin/entitlements) on the use of credit-consuming features
56+
57+
To learn more about credits and billing, please reach out to your account manager or [support@sourcegraph.com](mailto:support@sourcegraph.com).

‎docs/sla/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ seoPriority: 1.0
1111

1212
## Service Level Agreements (SLAs)
1313

14-
Our service level agreements (SLAs) are designed for products that are generally available and exclude [beta and experimental features](/admin/beta-and-experimental-features). SLA response times indicate how quickly we aim to provide an initial response to your inquiries or concerns. Our team will resolve all issues as quickly as possible. However, it's important to understand that SLA times differ from guaranteed resolution times.
14+
Our service level agreements (SLAs) are designed for products that are generally available and exclude [beta and experimental features](/beta-and-experimental). SLA response times indicate how quickly we aim to provide an initial response to your inquiries or concerns. Our team will resolve all issues as quickly as possible. However, it's important to understand that SLA times differ from guaranteed resolution times.
1515

1616
While we always strive to respond to your issues as quickly as possible, our SLAs are specifically applicable from Monday through Friday.
1717

@@ -119,7 +119,7 @@ Premium SLAs give customers access to our Support team 24x7 for Severity 0 and 1
119119

120120
First response times remain the same according to our SLAs. However, Emergency and Severe Impact issues are supported 24x7 with Premium Support (versus 24x5 without Premium Support).
121121

122-
This service is provided for all GA products Sourcegraph offers, not for any [Experimental or Beta features](/admin/beta-and-experimental-features).
122+
This service is provided for all GA products Sourcegraph offers, not for any [Experimental or Beta features](/beta-and-experimental).
123123

124124
> NOTE: This package includes access to Slack Support
125125

‎src/data/navigation.ts‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export const navigation: NavigationItem[] = [
9090
]
9191
},
9292
{
93-
title: 'Cody FAQs',
93+
title: 'Code Search FAQs',
9494
href: '/code-search/faq'
9595
}
9696
]
@@ -258,7 +258,7 @@ export const navigation: NavigationItem[] = [
258258
title: 'Troubleshooting Cody',
259259
href: '/cody/troubleshooting'
260260
},
261-
{title: 'Administration FAQ', href: '/cody/faq'}
261+
{title: 'Cody FAQ', href: '/cody/faq'}
262262
]
263263
}
264264
]
@@ -590,6 +590,10 @@ export const navigation: NavigationItem[] = [
590590
}
591591
]
592592
},
593+
{
594+
title: 'Sourcegraph Model Provider',
595+
href: '/model-provider'
596+
},
593597
{
594598
title: 'Sourcegraph Analytics',
595599
href: '/analytics',
@@ -599,8 +603,8 @@ export const navigation: NavigationItem[] = [
599603
]
600604
},
601605
{
602-
title: 'Sourcegraph Model Provider',
603-
href: '/model-provider'
606+
title: 'Sourcegraph Accounts',
607+
href: '/sourcegraph-accounts'
604608
}
605609
]
606610
},
@@ -621,24 +625,20 @@ export const navigation: NavigationItem[] = [
621625
separator: 'Help & support',
622626
topics: [
623627
{
624-
title: 'SLAs and premium support',
625-
href: '/sla'
626-
},
627-
{
628-
title: 'Sourcegraph tutorials',
629-
href: '/tutorials'
628+
title: 'Changelog',
629+
href: 'https://sourcegraph.com/changelog'
630630
},
631631
{
632-
title: 'Sourcegraph Accounts',
633-
href: '/sourcegraph-accounts'
632+
title: 'Beta and experimental features',
633+
href: '/beta-and-experimental'
634634
},
635635
{
636-
title: 'Changelog',
637-
href: 'https://sourcegraph.com/changelog'
636+
title: 'SLAs and premium support',
637+
href: '/sla'
638638
},
639639
{
640-
title: 'Sourcegraph releases',
641-
href: '/releases'
640+
title: 'Tutorials',
641+
href: '/tutorials'
642642
}
643643
]
644644
}

‎src/data/redirects.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6460,7 +6460,7 @@ const redirectsData = [
64606460
},
64616461
{
64626462
source: '/admin/beta_and_experimental_features',
6463-
destination: '/admin/beta-and-experimental-features',
6463+
destination: '/beta-and-experimental',
64646464
permanent: true
64656465
},
64666466
{
@@ -7134,6 +7134,11 @@ const redirectsData = [
71347134
destination: '/admin/permissions',
71357135
permanent: true
71367136
},
7137+
{
7138+
source: '/admin/beta-and-experimental-features',
7139+
destination: '/beta-and-experimental',
7140+
permanent: true
7141+
},
71377142
// RSS feed moved from /docs/technical-changelog.rss to /changelog/technical-changelog.rss
71387143
// This redirect preserves existing RSS subscriptions
71397144
{

0 commit comments

Comments
 (0)