Commit Graph

13 Commits

Author SHA1 Message Date
David Veszelovszki
68ed0abf80
Docs: Replace hyphens in text with em-dashes (#42367) 2023-01-31 13:18:49 +01:00
Robert Lin
91a0d5716a
monitoring: rebrand PossibleSolutions as NextSteps (#36500)
Rebrands PossibleSolutions as NextSteps to lower the bar for this field (the instructions don't need to provide an immediate solution, just guide the next steps once an alert is received)

To accommodate this, also makes the following changes:

- Refined guidance for how to write NextSteps
- alert_solutions.md -> alerts.md (+ redirect)
- prom-wrapper templates now indicate next steps instead of solutions
2022-06-02 10:51:06 -07:00
Jeff Wayman
a1f95f0afa
Product Education: Rewrite for Overview, Docker Compose, and Docker Single Container to align to new IA and deployment focus (#34715)
* Overall update to admin\install

These changes impact the install section with an update to include a deployment overview and a reorganization of the Docker Compose and Single-container sections. Because of a directory name change, I also have updated all other links directly.

* Remove old install files.

Removed indexes for Docker Compose and Single Container, as well as the separate operations guides as they are now part of the main docs.

* Updated admin index.

Added some links to the admin main page.

* Update redirects

Fix to redirect links.

* Update site_config.md

Updated link.

* Link fixes.

Various links associated with directory/folder change for deployment fixed.

* Various fixes based on review and link failures.

Fixed Buildkite link failures and implemented issues found during review.

* Update doc/admin/deploy/docker-compose/index.md

Suggested edit for clarification.

Co-authored-by: Michael Lin <mlzc@hey.com>

* Edits to correct link issues.

* Link fix. Removed sentence given redundant.

* Update git_server.go

Updated links to new location.

* update gitserver solutions or sth

* Deployment type table update.

Removed checkmarks (which have varied meanings globally), and the colored circles for easy/medium/hard (which may not be accessible for some readers).

* Update links for Kubernetes.

Added distinct links for k8s w/ and w/out Helm.

* Update doc/admin/how-to/redis_configmap.md

Fix link typo.

Co-authored-by: Crystal Augustus <91073224+caugustus-sourcegraph@users.noreply.github.com>

* Update doc/admin/deploy/index.md

Co-authored-by: Crystal Augustus <91073224+caugustus-sourcegraph@users.noreply.github.com>

* Update doc/admin/deploy/index.md

Co-authored-by: Crystal Augustus <91073224+caugustus-sourcegraph@users.noreply.github.com>

* Update doc/admin/deploy/docker-single-container/index.md

Co-authored-by: Crystal Augustus <91073224+caugustus-sourcegraph@users.noreply.github.com>

* Various changes based on review.

* Fix unintended update due to VS Code Extension.

* Fixed markdown numbering issue.

* Minor edits to correct links and deployment language.

* Moved location of Cloud installation docs within Docker Compose IA

* Updates based on review.

Improved language related to k8s w/helm. Removed language around CPU core recommendation.

* added more redirects to address link changes.

Co-authored-by: Michael Lin <mlzc@hey.com>
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
Co-authored-by: Crystal Augustus <91073224+caugustus-sourcegraph@users.noreply.github.com>
2022-05-06 12:54:45 -04:00
Robert Lin
24fad2987f
doc: move version and alert annotations demo to docsite (#28692) 2021-12-08 10:34:25 -08:00
Giselle Northy
82b5782419
fix typo (#24919) 2021-09-13 13:14:36 -07:00
Robert Lin
34c4095f5f
docs: document recent monitoring changes (#17233)
Adds admin and changelog documentation on some recent monitoring changes:

- #17072
- #17069
- #17158
- #17070

Dev docs also show up before admin docs if you search for "grafana" or "prometheus", so adds notices that point back to the admin docs.
2021-01-15 08:58:51 +08:00
Robert Lin
6a6f0ab5b9
doc(dev): monitoring how-to guides, observability background (#16965)
Co-authored-by: uwedeportivo <534011+uwedeportivo@users.noreply.github.com>
2020-12-24 14:51:42 +08:00
Robert Lin
ef7f19a756
monitoring: dashboards reference, refresh observability docs (#16939)
- New monitoring definition field, 'Interpretation'
- New generated dashboards reference
- Grafana panels now link to alert solutions and dashboards reference
- Refreshed observability docs

Co-authored-by: uwedeportivo <534011+uwedeportivo@users.noreply.github.com>
2020-12-23 10:36:41 +08:00
Gonzalo Peci
900564959a
Reword monitoring federation recommendation (#16511)
Co-authored-by: Robert Lin <robert@bobheadxi.dev>
2020-12-14 19:09:14 +01:00
Stephen Gutekanst
010087c599
observability: document Prometheus federation as an option (#10176)
* observability: document Prometheus federation as an option

* add period
2020-04-24 15:31:20 -07:00
Stephen Gutekanst
1bd66e59dc
metrics FAQ cleanups (#9618) 2020-04-06 17:32:41 -07:00
Stephen Gutekanst
eafb0e892c
doc/admin/observability/metrics: add FAQ entries (#9617) 2020-04-06 17:20:22 -07:00
Beyang Liu
aa93b002b8
Overhaul observability docs (#8925)
* update sidebar: "Monitoring" -> "Observability"
* update admin page
* "monitoring and tracing" -> "observability"
* consolidate and reorganize documentation on metrics, alerting, tracing, and troubleshooting
* make every page reachable
* update /-/debug tracing instructions
2020-03-12 15:36:34 -07:00