summaryrefslogtreecommitdiff
path: root/doc/development/performance.md
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2018-11-13 16:07:16 +1000
committerEvan Read <eread@gitlab.com>2019-01-08 12:21:09 +1000
commitd98560c1f5c54127d1a48c4c8e326bbf06c31c4b (patch)
treeb2d2fc26829e0a7b25da18d09a1e7e07ba1efed8 /doc/development/performance.md
parent710f2ec50c49d1e773acc20058ed584f1402de33 (diff)
downloadgitlab-ce-d98560c1f5c54127d1a48c4c8e326bbf06c31c4b.tar.gz
Make unordered lists conform to styleguidedocs/fix-unordered-list-style
- Also makes other minor Markdown fixes that were near the main fixes.
Diffstat (limited to 'doc/development/performance.md')
-rw-r--r--doc/development/performance.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/development/performance.md b/doc/development/performance.md
index 4cc2fdc9a58..972c93be817 100644
--- a/doc/development/performance.md
+++ b/doc/development/performance.md
@@ -23,9 +23,9 @@ The process of solving performance problems is roughly as follows:
When providing timings make sure to provide:
-* The 95th percentile
-* The 99th percentile
-* The mean
+- The 95th percentile
+- The 99th percentile
+- The mean
When providing screenshots of graphs, make sure that both the X and Y axes and
the legend are clearly visible. If you happen to have access to GitLab.com's own
@@ -36,12 +36,12 @@ graphs/dashboards.
GitLab provides built-in tools to help improve performance and availability:
-* [Profiling](profiling.md)
- * [Sherlock](profiling.md#sherlock)
-* [GitLab Performance Monitoring](../administration/monitoring/performance/index.md)
-* [Request Profiling](../administration/monitoring/performance/request_profiling.md)
-* [QueryRecoder](query_recorder.md) for preventing `N+1` regressions
-* [Chaos endpoints](chaos_endpoints.md) for testing failure scenarios. Intended mainly for testing availability.
+- [Profiling](profiling.md).
+ - [Sherlock](profiling.md#sherlock).
+- [GitLab Performance Monitoring](../administration/monitoring/performance/index.md).
+- [Request Profiling](../administration/monitoring/performance/request_profiling.md).
+- [QueryRecoder](query_recorder.md) for preventing `N+1` regressions.
+- [Chaos endpoints](chaos_endpoints.md) for testing failure scenarios. Intended mainly for testing availability.
GitLab employees can use GitLab.com's performance monitoring systems located at
<https://dashboards.gitlab.net>, this requires you to log in using your
@@ -269,11 +269,11 @@ piece of code is worth optimizing. The only two things you can do are:
Some examples of changes that aren't really important/worth the effort:
-* Replacing double quotes with single quotes.
-* Replacing usage of Array with Set when the list of values is very small.
-* Replacing library A with library B when both only take up 0.1% of the total
+- Replacing double quotes with single quotes.
+- Replacing usage of Array with Set when the list of values is very small.
+- Replacing library A with library B when both only take up 0.1% of the total
execution time.
-* Calling `freeze` on every string (see [String Freezing](#string-freezing)).
+- Calling `freeze` on every string (see [String Freezing](#string-freezing)).
## Slow Operations & Sidekiq