-
Notifications
You must be signed in to change notification settings - Fork 109
馃 Sync generated docs from sourcegraph/sourcegraph #1883
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sourcegraph-buildkite
wants to merge
1
commit into
main
Choose a base branch
from
sync/generated-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,12 +1,12 @@ | ||||||
| # Private metadata allowlist | ||||||
|
|
||||||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||||||
| This document lists all telemetry events that are allowed to export specific `privateMetadata` fields (from within [telemetry event parameters](https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters)). | ||||||
| By default, `privateMetadata` is **never** exported from customers because it can contain arbitrarily-shaped data that may accidentally include sensitive or private contents. | ||||||
| The specific events and properties listed below have been individually reviewed and approved for export. | ||||||
| The implementation of each is monitored to ensure they contain only categorized, enumerated information. | ||||||
|
|
||||||
| The only `metadata` we collect by default are non-sensitive numeric values. | ||||||
| To learn more, refer to the [telemetry documentation](/admin/telemetry). | ||||||
| To learn more, refer to the [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| | **Event feature** | **Event action** | **Allowed `privateMetadata` fields** | | ||||||
| | :---------------- | :--------------- | :----------------------------------- | | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,7 +3,7 @@ | |||||
|
|
||||||
| This page contains the core schema for telemetry event data that gets exported from Sourcegraph. | ||||||
|
|
||||||
| To learn more, refer to our [telemetry documentation](/admin/telemetry). | ||||||
| To learn more, refer to our [telemetry documentation](https://sourcegraph.com/docs/admin/telemetry). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Table of Contents | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # `src debug` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src debug' gathers and bundles debug data from a Sourcegraph deployment for troubleshooting. | ||
|
|
||
| Usage: | ||
|
|
||
| src debug command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| kube dumps context from k8s deployments | ||
| compose dumps context from docker-compose deployments | ||
| server dumps context from single-container deployments | ||
|
|
||
|
|
||
| Use "src debug command -h" for more information about a subcommands. | ||
| src debug has access to flags on src -- Ex: src -v kube -o foo.zip | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # `src search-jobs` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src search-jobs' is a tool that manages search jobs on a Sourcegraph instance. | ||
|
|
||
| Usage: | ||
|
|
||
| src search-jobs command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| cancel cancels a search job by ID | ||
| create creates a search job | ||
| delete deletes a search job by ID | ||
| get gets a search job by ID | ||
| list lists search jobs | ||
| logs fetches logs for a search job by ID | ||
| restart restarts a search job by ID | ||
| results fetches results for a search job by ID | ||
|
|
||
| Common options for all commands: | ||
| -c Select columns to display (e.g., -c id,query,state,username) | ||
| -json Output results in JSON format | ||
|
|
||
| Use "src search-jobs [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # `src snapshot` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src snapshot' manages snapshots of Sourcegraph instance databases. All subcommands are currently EXPERIMENTAL. | ||
|
|
||
| Usage: | ||
|
|
||
| src snapshot <command> | ||
|
|
||
| The commands are: | ||
|
|
||
| databases export databases from a Sourcegraph instance | ||
| restore restore databases from an export | ||
| upload upload exported databases and summary file when migrating to Sourcegraph Cloud | ||
|
|
||
| summary export summary data about an instance for acceptance testing of a restored Sourcegraph instance | ||
| test use exported summary data and instance health indicators to validate a restored and upgraded instance | ||
|
|
||
| Use "src snapshot [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # `src teams` | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
| 'src teams' is a tool that manages teams in a Sourcegraph instance. | ||
|
|
||
| Usage: | ||
|
|
||
| src teams command [command options] | ||
|
|
||
| The commands are: | ||
|
|
||
| list lists teams | ||
| create create a team | ||
| update update a team | ||
| delete delete a team | ||
| members manage team members, use "src teams members [command] -h" for more information. | ||
|
|
||
| Use "src teams [command] -h" for more information about a command. | ||
|
|
||
|
|
||
| ``` | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://sourcegraph.com/docs/admin/telemetry/protocol#telemetrygateway-v1-EventParameters: Absolute self-link; use "/admin/telemetry/protocol#telemetrygateway-v1-EventParameters" instead