diff options
| author | Adam Niedzielski <adamsunday@gmail.com> | 2017-04-10 16:52:25 +0200 |
|---|---|---|
| committer | Adam Niedzielski <adamsunday@gmail.com> | 2017-04-10 16:52:25 +0200 |
| commit | 075bdd6cadbf36bb297157671dafaf30b165f959 (patch) | |
| tree | cf6e9fb366501bbd027bc17d4f8cd917a98c95f8 /doc/development | |
| parent | c98add157732004d9a2eaa39770edf84eaca6896 (diff) | |
| download | gitlab-ce-075bdd6cadbf36bb297157671dafaf30b165f959.tar.gz | |
Document how polling interval is useddocument-polling-interval
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/fe_guide/performance.md | 4 | ||||
| -rw-r--r-- | doc/development/polling.md | 1 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/development/fe_guide/performance.md b/doc/development/fe_guide/performance.md index 9437a5f7a6e..e74eb729515 100644 --- a/doc/development/fe_guide/performance.md +++ b/doc/development/fe_guide/performance.md @@ -12,8 +12,8 @@ Thus, we must strike a balance between sending requests and the feeling of realt Use the following rules when creating realtime solutions. 1. The server will tell you how much to poll by sending `Poll-Interval` in the header. -Use that as your polling interval. This way it is easy for system administrators to change the -polling rate. +Use that as your polling interval. This way it is [easy for system administrators to change the +polling rate](../../administration/polling.md). A `Poll-Interval: -1` means you should disable polling, and this must be implemented. 1. A response with HTTP status `4XX` or `5XX` should disable polling as well. 1. Use a common library for polling. diff --git a/doc/development/polling.md b/doc/development/polling.md index 05e19f0c515..3b34f985cd4 100644 --- a/doc/development/polling.md +++ b/doc/development/polling.md @@ -51,5 +51,6 @@ request path. By doing this we avoid query parameter ordering problems and make route matching easier. For more information see: +- [`Poll-Interval` header](fe_guide/performance.md#realtime-components) - [RFC 7232](https://tools.ietf.org/html/rfc7232) - [ETag proposal](https://gitlab.com/gitlab-org/gitlab-ce/issues/26926) |