diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/members.md | 4 | ||||
-rw-r--r-- | doc/development/import_export.md | 43 | ||||
-rw-r--r-- | doc/development/what_requires_downtime.md | 3 | ||||
-rw-r--r-- | doc/user/project/integrations/prometheus.md | 2 | ||||
-rw-r--r-- | doc/user/project/settings/import_export.md | 33 |
5 files changed, 36 insertions, 49 deletions
diff --git a/doc/api/members.md b/doc/api/members.md index 69c52a54a8d..e9131e2d4c3 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -17,6 +17,8 @@ The access levels are defined in the `Gitlab::Access` module. Currently, these l Gets a list of group or project members viewable by the authenticated user. Returns only direct members and not inherited members through ancestors groups. +This function takes pagination parameters `page` and `per_page` to restrict the list of users. + ```plaintext GET /groups/:id/members GET /projects/:id/members @@ -72,6 +74,8 @@ Gets a list of group or project members viewable by the authenticated user, incl When a user is a member of the project/group and of one or more ancestor groups the user is returned only once with the project `access_level` (if exists) or the `access_level` for the user in the first group which they belong to in the project groups ancestors chain. +This function takes pagination parameters `page` and `per_page` to restrict the list of users. + ```plaintext GET /groups/:id/members/all GET /projects/:id/members/all diff --git a/doc/development/import_export.md b/doc/development/import_export.md index 323ed48aaf9..252a57ce857 100644 --- a/doc/development/import_export.md +++ b/doc/development/import_export.md @@ -195,16 +195,17 @@ module Gitlab The [current version history](../user/project/settings/import_export.md) also displays the equivalent GitLab version and it is useful for knowing which versions won't be compatible between them. -| GitLab version | Import/Export version | -| ---------------- | --------------------- | -| 11.1 to current | 0.2.4 | -| 10.8 | 0.2.3 | -| 10.4 | 0.2.2 | -| ... | ... | -| 8.10.3 | 0.1.3 | -| 8.10.0 | 0.1.2 | -| 8.9.5 | 0.1.1 | -| 8.9.0 | 0.1.0 | +| Exporting GitLab version | Importing GitLab version | +| -------------------------- | -------------------------- | +| 11.7 to current | 11.7 to current | +| 11.1 to 11.6 | 11.1 to 11.6 | +| 10.8 to 11.0 | 10.8 to 11.0 | +| 10.4 to 10.7 | 10.4 to 10.7 | +| ... | ... | +| 8.10.3 to 8.11 | 8.10.3 to 8.11 | +| 8.10.0 to 8.10.2 | 8.10.0 to 8.10.2 | +| 8.9.5 to 8.9.11 | 8.9.5 to 8.9.11 | +| 8.9.0 to 8.9.4 | 8.9.0 to 8.9.4 | ### When to bump the version up @@ -223,28 +224,6 @@ Every time we bump the version, the integration specs will fail and can be fixed bundle exec rake gitlab:import_export:bump_version ``` -### Renaming columns or models - -This is a relatively common occurrence that will require a version bump. - -There is also the _RC problem_ - GitLab.com runs an RC, prior to any customers, -meaning that we want to bump the version up in the next version (or patch release). - -For example: - -1. Add rename to `RelationRenameService` in X.Y -1. Remove it from `RelationRenameService` in X.Y + 1 -1. Bump Import/Export version in X.Y + 1 - -```ruby -module Gitlab - module ImportExport - class RelationRenameService - RENAMES = { - 'pipelines' => 'ci_pipelines' # Added in 11.6, remove in 11.7 - }.freeze -``` - ## A quick dive into the code ### Import/Export configuration (`import_export.yml`) diff --git a/doc/development/what_requires_downtime.md b/doc/development/what_requires_downtime.md index a25d065f735..b7c667d034b 100644 --- a/doc/development/what_requires_downtime.md +++ b/doc/development/what_requires_downtime.md @@ -162,6 +162,9 @@ class CleanupUsersUpdatedAtRename < ActiveRecord::Migration[4.2] end ``` +NOTE: **Note:** If you're renaming a large table, please carefully consider the state when the first migration has run but the second cleanup migration hasn't been run yet. +With [Canary](https://about.gitlab.com/handbook/engineering/infrastructure/library/canary/) it is possible that the system runs in this state for a significant amount of time. + ## Changing Column Constraints Adding or removing a NOT NULL clause (or another constraint) can typically be diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index bbe2f88795e..475eb4a55b9 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -769,7 +769,7 @@ Prerequisites for embedding from a Grafana instance: 1. In the upper-left corner of the page, select a specific value for each variable required for the queries in the chart. ![Select Query Variables](img/select_query_variables_v12_5.png) 1. In Grafana, click on a panel's title, then click **Share** to open the panel's sharing dialog to the **Link** tab. -1. If your Prometheus queries use Grafana's custom template variables, ensure that "Template variables" and "Current time range" options are toggled to **On**. Of Grafana global template variables, only `$__interval`, `$__from`, and `$__to` are currently supported. +1. If your Prometheus queries use Grafana's custom template variables, ensure that "Template variables" option is toggled to **On**. Of Grafana global template variables, only `$__interval`, `$__from`, and `$__to` are currently supported. Toggle **On** the "Current time range" option to specify the time range of the chart. Otherwise, the default range will be the last 8 hours. ![Grafana Sharing Dialog](img/grafana_sharing_dialog_v12_5.png) 1. Click **Copy** to copy the URL to the clipboard. 1. In GitLab, paste the URL into a Markdown field and save. The chart will take a few moments to render. diff --git a/doc/user/project/settings/import_export.md b/doc/user/project/settings/import_export.md index 1a4023b6ded..d32b4847230 100644 --- a/doc/user/project/settings/import_export.md +++ b/doc/user/project/settings/import_export.md @@ -42,22 +42,23 @@ Note the following: The following table lists updates to Import/Export: -| GitLab version | Import/Export schema version | -| ---------------- | --------------------- | -| 11.1 to current | 0.2.4 | -| 10.8 | 0.2.3 | -| 10.4 | 0.2.2 | -| 10.3 | 0.2.1 | -| 10.0 | 0.2.0 | -| 9.4.0 | 0.1.8 | -| 9.2.0 | 0.1.7 | -| 8.17.0 | 0.1.6 | -| 8.13.0 | 0.1.5 | -| 8.12.0 | 0.1.4 | -| 8.10.3 | 0.1.3 | -| 8.10.0 | 0.1.2 | -| 8.9.5 | 0.1.1 | -| 8.9.0 | 0.1.0 | +| Exporting GitLab version | Importing GitLab version | +| -------------------------- | -------------------------- | +| 11.7 to current | 11.7 to current | +| 11.1 to 11.6 | 11.1 to 11.6 | +| 10.8 to 11.0 | 10.8 to 11.0 | +| 10.4 to 10.7 | 10.4 to 10.7 | +| 10.3 | 10.3 | +| 10.0 to 10.2 | 10.0 to 10.2 | +| 9.4 to 9.6 | 9.4 to 9.6 | +| 9.2 to 9.3 | 9.2 to 9.3 | +| 8.17 to 9.1 | 8.17 to 9.1 | +| 8.13 to 8.16 | 8.13 to 8.16 | +| 8.12 | 8.12 | +| 8.10.3 to 8.11 | 8.10.3 to 8.11 | +| 8.10.0 to 8.10.2 | 8.10.0 to 8.10.2 | +| 8.9.5 to 8.9.11 | 8.9.5 to 8.9.11 | +| 8.9.0 to 8.9.4 | 8.9.0 to 8.9.4 | Projects can be exported and imported only between versions of GitLab with matching Import/Export versions. |