You can see all available commands for manipulating editor content by pressing
You can see all available commands for manipulating editor content by pressing
the <kbd>F1</kbd> key when the editor is in focus. After that,
the <kbd>F1</kbd> key when the editor is in focus. After that, the editor displays
you'll see a complete list of available commands for
a complete list of available commands for
manipulating editor content. The editor supports commands for multi-cursor
manipulating editor content. The editor supports commands for multi-cursor
editing, code block folding, commenting, searching and replacing, navigating
editing, code block folding, commenting, searching and replacing, navigating
editor warnings and suggestions, and more.
editor warnings and suggestions, and more.
...
@@ -78,7 +78,7 @@ All the themes GitLab supports for syntax highlighting are added to the Web IDE'
...
@@ -78,7 +78,7 @@ All the themes GitLab supports for syntax highlighting are added to the Web IDE'
You can pick a theme from your [profile preferences](../../profile/preferences.md).
You can pick a theme from your [profile preferences](../../profile/preferences.md).
The themes are available only in the Web IDE file editor, except for the [dark theme](https://gitlab.com/gitlab-org/gitlab/-/issues/209808) and
The themes are available only in the Web IDE file editor, except for the [dark theme](https://gitlab.com/gitlab-org/gitlab/-/issues/209808) and
the [solarized dark theme](https://gitlab.com/gitlab-org/gitlab/-/issues/219228),
the [Solarized dark theme](https://gitlab.com/gitlab-org/gitlab/-/issues/219228),
which apply to the entire Web IDE screen.
which apply to the entire Web IDE screen.
| Solarized Light Theme | Solarized Dark Theme | Dark Theme |
| Solarized Light Theme | Solarized Dark Theme | Dark Theme |
...
@@ -144,12 +144,13 @@ schemas:
...
@@ -144,12 +144,13 @@ schemas:
Each schema entry supports two properties:
Each schema entry supports two properties:
-`uri`: please provide an absolute URL for the schema definition file here. The schema from this URL
-`uri`: please provide an absolute URL for the schema definition file here.
is loaded when a matching file is open.
The schema from this URL is loaded when a matching file is open.
-`match`: a list of matching paths or glob expressions. If a schema matches a particular path pattern,
-`match`: a list of matching paths or glob expressions. If a schema matches a
it will be applied to that file. Please enclose the pattern in quotes if it begins with an asterisk (`*`),
particular path pattern, it is applied to that file. Please enclose the pattern
it's be applied to that file. If a pattern begins with an asterisk (`*`), enclose it in quotation
in quotes if it begins with an asterisk (`*`), it's be applied to that file.
marks. Otherwise, the configuration file is not valid YAML.
If a pattern begins with an asterisk (`*`), enclose it in quotation marks.
Otherwise, the configuration file is not valid YAML.
## Configure the Web IDE
## Configure the Web IDE
...
@@ -325,7 +326,7 @@ In order to enable the Web IDE terminals you need to create the file
...
@@ -325,7 +326,7 @@ In order to enable the Web IDE terminals you need to create the file
file is fairly similar to the [CI configuration file](../../../ci/yaml/README.md)
file is fairly similar to the [CI configuration file](../../../ci/yaml/README.md)
syntax but with some restrictions:
syntax but with some restrictions:
- No global blocks can be defined (i.e., `before_script` or `after_script`)
- No global blocks (such as `before_script` or `after_script`) can be defined.
- Only one job named `terminal` can be added to this file.
- Only one job named `terminal` can be added to this file.
- Only the keywords `image`, `services`, `tags`, `before_script`, `script`, and
- Only the keywords `image`, `services`, `tags`, `before_script`, `script`, and
`variables` are allowed to be used to configure the job.
`variables` are allowed to be used to configure the job.
...
@@ -434,7 +435,7 @@ terminal is started, a **Terminal** status is visible in the status bar.
...
@@ -434,7 +435,7 @@ terminal is started, a **Terminal** status is visible in the status bar.
Changes made to your files via the Web IDE sync to the running terminal
Changes made to your files via the Web IDE sync to the running terminal
when:
when:
-<kbd>Ctrl</kbd> + <kbd>S</kbd> (or <kbd>Cmd</kbd> + <kbd>S</kbd> on Mac)
-<kbd>Control</kbd> + <kbd>S</kbd> (or <kbd>Command</kbd> + <kbd>S</kbd> on Mac)
is pressed while editing a file.
is pressed while editing a file.
- Anything outside the file editor is clicked after editing a file.
- Anything outside the file editor is clicked after editing a file.
- A file or folder is created, deleted, or renamed.
- A file or folder is created, deleted, or renamed.
...
@@ -446,7 +447,7 @@ The Web IDE has a few limitations:
...
@@ -446,7 +447,7 @@ The Web IDE has a few limitations:
- Interactive Terminals is in a beta phase and continues to be improved in upcoming releases. In the meantime, please note that the user is limited to having only one
- Interactive Terminals is in a beta phase and continues to be improved in upcoming releases. In the meantime, please note that the user is limited to having only one
active terminal at a time.
active terminal at a time.
- LFS files can be rendered and displayed but they cannot be updated and committed using the Web IDE. If an LFS file is modified and pushed to the repository, the LFS pointer in the repository will be overwritten with the modified LFS file content.
- LFS files can be rendered and displayed but they cannot be updated and committed using the Web IDE. If an LFS file is modified and pushed to the repository, the LFS pointer in the repository is overwritten with the modified LFS file content.
@@ -18,7 +18,7 @@ The number displayed on their right represents the number of issues and merge re
...
@@ -18,7 +18,7 @@ The number displayed on their right represents the number of issues and merge re
![issues and MRs dashboard links](img/dashboard_links.png)
![issues and MRs dashboard links](img/dashboard_links.png)
When you click **Issues**, you'll see the opened issues assigned to you straight away:
When you click **Issues**, the opened issues assigned to you are shown straight away:
![Issues assigned to you](img/issues_assigned_to_you.png)
![Issues assigned to you](img/issues_assigned_to_you.png)
...
@@ -29,7 +29,7 @@ You can also filter the results using the search and filter field, as described
...
@@ -29,7 +29,7 @@ You can also filter the results using the search and filter field, as described
### Issues and MRs assigned to you or created by you
### Issues and MRs assigned to you or created by you
You'll also find shortcuts to issues and merge requests created by you or assigned to you
GitLab shows shortcuts to issues and merge requests created by you or assigned to you
on the search field on the top-right of your screen:
on the search field on the top-right of your screen:
![shortcut to your issues and merge requests](img/issues_mrs_shortcut.png)
![shortcut to your issues and merge requests](img/issues_mrs_shortcut.png)
...
@@ -74,7 +74,7 @@ Some filter fields like milestone and assignee, allow you to filter by **None**
...
@@ -74,7 +74,7 @@ Some filter fields like milestone and assignee, allow you to filter by **None**
![filter by none any](img/issues_filter_none_any.png)
![filter by none any](img/issues_filter_none_any.png)
Selecting **None** returns results that have an empty value for that field. E.g.: no milestone, no assignee.
Selecting **None** returns results that have an empty value for that field. For example: no milestone, no assignee.
Selecting **Any** does the opposite. It returns results that have a non-empty value for that field.
Selecting **Any** does the opposite. It returns results that have a non-empty value for that field.
...
@@ -83,11 +83,11 @@ Selecting **Any** does the opposite. It returns results that have a non-empty va
...
@@ -83,11 +83,11 @@ Selecting **Any** does the opposite. It returns results that have a non-empty va
You can filter issues and merge requests by specific terms included in titles or descriptions.
You can filter issues and merge requests by specific terms included in titles or descriptions.
- Syntax
- Syntax
- Searches look for all the words in a query, in any order. E.g.: searching
- Searches look for all the words in a query, in any order. For example: searching
issues for `display bug`will return all issues matching both those words, in any order.
issues for `display bug`returns all issues matching both those words, in any order.
- To find the exact term, use double quotes: `"display bug"`
- To find the exact term, use double quotes: `"display bug"`
- Limitation
- Limitation
- For performance reasons, terms shorter than 3 chars are ignored. E.g.: searching
- For performance reasons, terms shorter than 3 chars are ignored. For example: searching
issues for `included in titles` is same as `included titles`
issues for `included in titles` is same as `included titles`
- Search is limited to 4096 characters and 64 terms per query.
- Search is limited to 4096 characters and 64 terms per query.
...
@@ -157,7 +157,7 @@ relevant users or other attributes.
...
@@ -157,7 +157,7 @@ relevant users or other attributes.
For performance optimization, there is a requirement of a minimum of three
For performance optimization, there is a requirement of a minimum of three
characters to begin your search. For example, if you want to search for
characters to begin your search. For example, if you want to search for
issues that have the assignee "Simone Presley", you'll need to type at
issues that have the assignee "Simone Presley", you must type at
least "Sim" before autocomplete gives any relevant results.
least "Sim" before autocomplete gives any relevant results.
## Search history
## Search history
...
@@ -170,11 +170,11 @@ You can view recent searches by clicking on the little arrow-clock icon, which i
...
@@ -170,11 +170,11 @@ You can view recent searches by clicking on the little arrow-clock icon, which i
Individual filters can be removed by clicking on the filter's (x) button or backspacing. The entire search filter can be cleared by clicking on the search box's (x) button or via <kbd>⌘</kbd> (Mac) + <kbd>⌫</kbd>.
Individual filters can be removed by clicking on the filter's (x) button or backspacing. The entire search filter can be cleared by clicking on the search box's (x) button or via <kbd>⌘</kbd> (Mac) + <kbd>⌫</kbd>.
To delete filter tokens one at a time, the <kbd>⌥</kbd> (Mac) / <kbd>Ctrl</kbd> + <kbd>⌫</kbd> keyboard combination can be used.
To delete filter tokens one at a time, the <kbd>⌥</kbd> (Mac) / <kbd>Control</kbd> + <kbd>⌫</kbd> keyboard combination can be used.
## Filtering with multiple filters of the same type
## Filtering with multiple filters of the same type
Some filters can be added multiple times. These include but are not limited to assignees and labels. When you filter with these multiple filters of the same type, the AND logic is applied. For example, if you were filtering `assignee:@sam assignee:@sarah`, your results will only include entries whereby the assignees are assigned to both Sam and Sarah are returned.
Some filters can be added multiple times. These include but are not limited to assignees and labels. When you filter with these multiple filters of the same type, the AND logic is applied. For example, if you were filtering `assignee:@sam assignee:@sarah`, your results include only entries whereby the assignees are assigned to both Sam and Sarah are returned.