Commit e1ecdc23 authored by Suzanne Selhorn's avatar Suzanne Selhorn

Removed references to planned features

Also added guidance to style guide.
We don't want to promise feature delivery
because it can raise legal issues.
parent ee5c4229
...@@ -152,8 +152,8 @@ The availability objectives for Gitaly clusters are: ...@@ -152,8 +152,8 @@ The availability objectives for Gitaly clusters are:
second. Failover requires ten consecutive failed health checks on each second. Failover requires ten consecutive failed health checks on each
Praefect node. Praefect node.
[Faster outage detection](https://gitlab.com/gitlab-org/gitaly/-/issues/2608) Faster outage detection, to improve this speed to less than 1 second,
is planned to improve this to less than 1 second. is tracked [in this issue](https://gitlab.com/gitlab-org/gitaly/-/issues/2608).
### Virtual storage ### Virtual storage
...@@ -176,8 +176,8 @@ The number of repository replicas can be configured using a ...@@ -176,8 +176,8 @@ The number of repository replicas can be configured using a
It can It can
be uneconomical to have the same replication factor for all repositories. be uneconomical to have the same replication factor for all repositories.
[Variable replication factor](https://gitlab.com/groups/gitlab-org/-/epics/3372) is planned to To provide greater flexibility for extremely large GitLab instances,
provide greater flexibility for extremely large GitLab instances. variable replication factor is tracked in [this issue](https://gitlab.com/groups/gitlab-org/-/epics/3372).
As with normal Gitaly storages, virtual storages can be sharded. As with normal Gitaly storages, virtual storages can be sharded.
......
...@@ -133,9 +133,9 @@ migrate your data out of object storage and back into your local storage. ...@@ -133,9 +133,9 @@ migrate your data out of object storage and back into your local storage.
WARNING: WARNING:
**Extended downtime is required** so no new files are created in object storage during **Extended downtime is required** so no new files are created in object storage during
the migration. A configuration setting is planned to allow migrating the migration. A configuration setting to allow migrating
from object storage to local files with only a brief moment of downtime for configuration changes. from object storage to local files with only a brief moment of downtime for configuration changes
To follow progress, see the [relevant issue](https://gitlab.com/gitlab-org/gitlab/-/issues/30979). is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/30979).
### All-in-one Rake task ### All-in-one Rake task
......
...@@ -33,8 +33,8 @@ Two things need to be configured for the interactive web terminal to work: ...@@ -33,8 +33,8 @@ Two things need to be configured for the interactive web terminal to work:
NOTE: NOTE:
Interactive web terminals are not yet supported by Interactive web terminals are not yet supported by
[`gitlab-runner` Helm chart](https://docs.gitlab.com/charts/charts/gitlab/gitlab-runner/index.html), [`gitlab-runner` Helm chart](https://docs.gitlab.com/charts/charts/gitlab/gitlab-runner/index.html).
but support [is planned](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/79). Support is tracked [in this issue](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/issues/79).
## Debugging a running job ## Debugging a running job
......
...@@ -91,8 +91,7 @@ To configure your Vault server: ...@@ -91,8 +91,7 @@ To configure your Vault server:
- `VAULT_AUTH_PATH` - (Optional) The path where the authentication method is mounted, default is `jwt`. - `VAULT_AUTH_PATH` - (Optional) The path where the authentication method is mounted, default is `jwt`.
NOTE: NOTE:
Support for [providing these values in the user interface](https://gitlab.com/gitlab-org/gitlab/-/issues/218677) Support for providing these values in the user interface [is tracked in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/218677).
is planned but not yet implemented.
## Use Vault secrets in a CI job **(PREMIUM)** ## Use Vault secrets in a CI job **(PREMIUM)**
......
...@@ -1575,7 +1575,7 @@ production: ...@@ -1575,7 +1575,7 @@ production:
name, they overwrite each other and only the last one downloaded is saved. name, they overwrite each other and only the last one downloaded is saved.
- `needs:` is similar to `dependencies:` in that it must use jobs from prior stages, - `needs:` is similar to `dependencies:` in that it must use jobs from prior stages,
meaning it's impossible to create circular dependencies. Depending on jobs in the meaning it's impossible to create circular dependencies. Depending on jobs in the
current stage is not possible either, but support [is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/30632). current stage is not possible either, but [an issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/30632).
- Stages must be explicitly defined for all jobs - Stages must be explicitly defined for all jobs
that have the keyword `needs:` or are referred to by one. that have the keyword `needs:` or are referred to by one.
......
...@@ -1585,6 +1585,18 @@ For example: ...@@ -1585,6 +1585,18 @@ For example:
- In GitLab 12.2 and earlier, ... - In GitLab 12.2 and earlier, ...
- In GitLab 11.6 and later, ... - In GitLab 11.6 and later, ...
### Promising features in future versions
Do not promise to deliver features in a future release. For example, avoid phrases like,
"Support for this feature is planned."
We cannot guarantee future feature work, and promises
like these can raise legal issues. Instead, say that an issue exists, for example,
"Support for this feature is tracked [in this issue]." Or, "Improvements to
this functionality are tracked [in this issue]."
You _can_ say that we plan to remove a feature.
### Removing versions after each major release ### Removing versions after each major release
Whenever a major GitLab release occurs, we remove all version references Whenever a major GitLab release occurs, we remove all version references
......
...@@ -51,7 +51,7 @@ which have to be stubbed. ...@@ -51,7 +51,7 @@ which have to be stubbed.
### Differences to Karma ### Differences to Karma
- Jest runs in a Node.js environment, not in a browser. Support for running Jest tests in a browser [is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/26982). - Jest runs in a Node.js environment, not in a browser. [An issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/26982) for running Jest tests in a browser.
- Because Jest runs in a Node.js environment, it uses [jsdom](https://github.com/jsdom/jsdom) by default. See also its [limitations](#limitations-of-jsdom) below. - Because Jest runs in a Node.js environment, it uses [jsdom](https://github.com/jsdom/jsdom) by default. See also its [limitations](#limitations-of-jsdom) below.
- Jest does not have access to Webpack loaders or aliases. - Jest does not have access to Webpack loaders or aliases.
The aliases used by Jest are defined in its [own configuration](https://gitlab.com/gitlab-org/gitlab/-/blob/master/jest.config.js). The aliases used by Jest are defined in its [own configuration](https://gitlab.com/gitlab-org/gitlab/-/blob/master/jest.config.js).
......
...@@ -120,7 +120,8 @@ We have three kinds of file encoding in our uploads: ...@@ -120,7 +120,8 @@ We have three kinds of file encoding in our uploads:
1. <i class="fa fa-check-circle"></i> **multipart**: `multipart/form-data` is the most common, a file is encoded as a part of a multipart encoded request. 1. <i class="fa fa-check-circle"></i> **multipart**: `multipart/form-data` is the most common, a file is encoded as a part of a multipart encoded request.
1. <i class="fa fa-check-circle"></i> **body**: some APIs uploads files as the whole request body. 1. <i class="fa fa-check-circle"></i> **body**: some APIs uploads files as the whole request body.
1. <i class="fa fa-times-circle"></i> **JSON**: some JSON API uploads files as base64 encoded strings. This requires a change to GitLab Workhorse, which [is planned](https://gitlab.com/gitlab-org/gitlab-workhorse/-/issues/226). 1. <i class="fa fa-times-circle"></i> **JSON**: some JSON API uploads files as base64 encoded strings. This requires a change to GitLab Workhorse,
which is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/325068).
## Uploading technologies ## Uploading technologies
......
...@@ -53,7 +53,7 @@ After a namespace is added: ...@@ -53,7 +53,7 @@ After a namespace is added:
are synced to Jira. are synced to Jira.
- From GitLab 13.8, past merge request data is synced to Jira. - From GitLab 13.8, past merge request data is synced to Jira.
Support for syncing past branch and commit data [is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/263240). Support for syncing past branch and commit data is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/263240).
## Install the GitLab.com for Jira Cloud app for self-managed instances **(FREE SELF)** ## Install the GitLab.com for Jira Cloud app for self-managed instances **(FREE SELF)**
......
...@@ -221,7 +221,6 @@ Users can be banned using the Admin Area. To do this: ...@@ -221,7 +221,6 @@ Users can be banned using the Admin Area. To do this:
NOTE: NOTE:
This feature is a work in progress. Currently, banning a user This feature is a work in progress. Currently, banning a user
only blocks them and does not hide their comments or issues. only blocks them and does not hide their comments or issues.
This functionality is planned to be implemented in follow up issues.
### Unban a user ### Unban a user
......
...@@ -488,8 +488,8 @@ To delete the underlying layers and images that aren't associated with any tags, ...@@ -488,8 +488,8 @@ To delete the underlying layers and images that aren't associated with any tags,
Cleanup policies can be run on all projects, with these exceptions: Cleanup policies can be run on all projects, with these exceptions:
- For GitLab.com, the project must have been created after 2020-02-22. - For GitLab.com, the project must have been created after 2020-02-22.
Support for projects created earlier Support for projects created earlier is tracked
[is planned](https://gitlab.com/gitlab-org/gitlab/-/issues/196124). [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/196124).
- For self-managed GitLab instances, the project must have been created - For self-managed GitLab instances, the project must have been created
in GitLab 12.8 or later. However, an administrator can enable the cleanup policy in GitLab 12.8 or later. However, an administrator can enable the cleanup policy
for all projects (even those created before 12.8) in for all projects (even those created before 12.8) in
......
...@@ -48,7 +48,7 @@ If the requirements are not met, the **Designs** tab displays a message to the u ...@@ -48,7 +48,7 @@ If the requirements are not met, the **Designs** tab displays a message to the u
Files uploaded must have a file extension of either `png`, `jpg`, `jpeg`, Files uploaded must have a file extension of either `png`, `jpg`, `jpeg`,
`gif`, `bmp`, `tiff`, `ico`, `webp`, or `svg`. `gif`, `bmp`, `tiff`, `ico`, `webp`, or `svg`.
Support for [PDF](https://gitlab.com/gitlab-org/gitlab/-/issues/32811) is planned for a future release. Support for PDF is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/32811).
## Limitations ## Limitations
......
...@@ -37,7 +37,8 @@ request thread. It crosslinks the new commit and the existing merge request. ...@@ -37,7 +37,8 @@ request thread. It crosslinks the new commit and the existing merge request.
Each deployment's [list of associated merge requests](../../../api/deployments.md#list-of-merge-requests-associated-with-a-deployment) includes cherry-picked merge commits. Each deployment's [list of associated merge requests](../../../api/deployments.md#list-of-merge-requests-associated-with-a-deployment) includes cherry-picked merge commits.
NOTE: NOTE:
We only track cherry-pick executed from GitLab (both UI and API). Support for [tracking cherry-picked commits through the command line](https://gitlab.com/gitlab-org/gitlab/-/issues/202215) is planned for a future release. We only track cherry-pick executed from GitLab (both UI and API). Support for tracking cherry-picked commits through the command line
is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/202215).
## Cherry-picking a commit ## Cherry-picking a commit
......
...@@ -225,7 +225,7 @@ A `_sidebar` example, formatted with Markdown: ...@@ -225,7 +225,7 @@ A `_sidebar` example, formatted with Markdown:
- [Sidebar](_sidebar) - [Sidebar](_sidebar)
``` ```
Support for displaying a generated table of contents with a custom side navigation is planned. Support for displaying a generated table of contents with a custom side navigation is being considered.
## Enable or disable a project wiki ## Enable or disable a project wiki
......
...@@ -215,8 +215,7 @@ which can encourage user collaboration. ...@@ -215,8 +215,7 @@ which can encourage user collaboration.
- Git tags are not supported in snippet repositories. - Git tags are not supported in snippet repositories.
- Snippets' repositories are limited to 10 files. Attempting to push more - Snippets' repositories are limited to 10 files. Attempting to push more
than 10 files results in an error. than 10 files results in an error.
- Revisions are not visible to the user on the GitLab UI, but this feature is planned - Revisions are not visible to the user on the GitLab UI, but [an issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/39271)
in future iterations. See the [revisions tab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/39271)
for updates. for updates.
- The [maximum size for a snippet](../administration/snippets/index.md#snippets-content-size-limit) - The [maximum size for a snippet](../administration/snippets/index.md#snippets-content-size-limit)
is 50 MB, by default. is 50 MB, by default.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment