Commit fdc9649e authored by Amy Qualls's avatar Amy Qualls

Revisions for tone, style, merge conflict

Fix merge conflict, bring closer to GitLab tone and style.
parent 761b31f5
......@@ -33,8 +33,8 @@ start seeing results.
## Command palette
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,
you'll see a complete list of available commands for
the <kbd>F1</kbd> key when the editor is in focus. After that, the editor displays
a complete list of available commands for
manipulating editor content. The editor supports commands for multi-cursor
editing, code block folding, commenting, searching and replacing, navigating
editor warnings and suggestions, and more.
......@@ -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).
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.
| Solarized Light Theme | Solarized Dark Theme | Dark Theme |
......@@ -144,12 +144,13 @@ schemas:
Each schema entry supports two properties:
- `uri`: please provide an absolute URL for the schema definition file here. 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,
it will be applied to that file. Please enclose the pattern in quotes if it begins with an asterisk (`*`),
it's be applied to that file. If a pattern begins with an asterisk (`*`), enclose it in quotation
marks. Otherwise, the configuration file is not valid YAML.
- `uri`: please provide an absolute URL for the schema definition file here.
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, it is applied to that file. Please enclose the pattern
in quotes if it begins with an asterisk (`*`), it's be applied to that file.
If a pattern begins with an asterisk (`*`), enclose it in quotation marks.
Otherwise, the configuration file is not valid YAML.
## Configure the Web IDE
......@@ -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)
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 the keywords `image`, `services`, `tags`, `before_script`, `script`, and
`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.
Changes made to your files via the Web IDE sync to the running terminal
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.
- Anything outside the file editor is clicked after editing a file.
- A file or folder is created, deleted, or renamed.
......@@ -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
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.
### Troubleshooting
......
......@@ -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)
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)
......@@ -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
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:
![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**
![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.
......@@ -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.
- Syntax
- Searches look for all the words in a query, in any order. E.g.: searching
issues for `display bug` will return all issues matching both those words, in any order.
- Searches look for all the words in a query, in any order. For example: searching
issues for `display bug` returns all issues matching both those words, in any order.
- To find the exact term, use double quotes: `"display bug"`
- 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`
- Search is limited to 4096 characters and 64 terms per query.
......@@ -157,7 +157,7 @@ relevant users or other attributes.
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
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.
## Search history
......@@ -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>.
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
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.
![multiple assignees filtering](img/multiple_assignees.png)
......@@ -190,7 +190,7 @@ author, type, and action. Also, you can sort them by
You can search through your projects from the left menu, by clicking the menu bar, then **Projects**.
On the field **Filter by name**, type the project or group name you want to find, and GitLab
will filter them for you as you type.
filters them for you as you type.
You can also look for the projects you [starred](../project/index.md#star-a-project) (**Starred projects**), and **Explore** all
public and internal projects available in GitLab.com, from which you can filter by visibility,
......@@ -207,7 +207,7 @@ Similarly to [projects search](#projects), you can search through your groups fr
the left menu, by clicking the menu bar, then **Groups**.
On the field **Filter by name**, type the group name you want to find, and GitLab
will filter them for you as you type.
filters them for you as you type.
You can also **Explore** all public and internal groups available in GitLab.com,
and sort them by **Last created**, **Oldest created**, **Last updated**, or **Oldest updated**.
......@@ -219,14 +219,14 @@ You can also filter them by name (issue title), from the field **Filter by name*
When you want to search for issues to add to lists present in your Issue Board, click
the button **Add issues** on the top-right of your screen, opening a modal window from which
you'll be able to, besides filtering them by **Name**, **Author**, **Assignee**, **Milestone**,
you can, besides filtering them by **Name**, **Author**, **Assignee**, **Milestone**,
and **Labels**, select multiple issues to add to a list of your choice:
![search and select issues to add to board](img/search_issues_board.png)
## Shortcut
You'll find a shortcut on the search field on the top-right of the project's dashboard to
GitLab shows a shortcut on the search field on the top-right of the project's dashboard to
quickly access issues and merge requests created or assigned to you in that project:
![search per project - shortcut](img/project_search.png)
......@@ -283,10 +283,10 @@ the search field on the top-right of your screen while the project page is open.
### SHA search
You can quickly access a commit from the project dashboard by entering the SHA
into the search field on the top right of the screen. If a single result is found, you will be
into the search field on the top right of the screen. If a single result is found, you are
redirected to the commit result and given the option to return to the search results page.
![project sha search redirect](img/project_search_sha_redirect.png)
![project SHA search redirect](img/project_search_sha_redirect.png)
## Advanced Search **(STARTER)**
......@@ -314,7 +314,7 @@ This feature might not be available to you. Check the **version history** note a
You can search inside the project’s settings sections by entering a search
term in the search box located at the top of the page. The search results
will appear highlighted in the sections that match the search term.
appear highlighted in the sections that match the search term.
![Search project settings](img/project_search_general_settings_v13_8.png)
......
......@@ -69,8 +69,8 @@ new commit to the master branch is recorded. Commit messages are automatically
generated. The snippet's repository has only one branch (master) by default, deleting
it or creating other branches is not supported.
Existing snippets will be automatically migrated in 13.0. Their current
content will be saved as the initial commit to the snippets' repository.
Existing snippets are automatically migrated in 13.0. Their current
content is saved as the initial commit to the snippets' repository.
### Filenames
......@@ -86,10 +86,10 @@ number increases incrementally when more snippets without an attributed
filename are added.
When upgrading from an earlier version of GitLab to 13.0, existing snippets
without a supported filename will be renamed to a compatible format. For
example, if the snippet's filename is `http://a-weird-filename.me` it will
be changed to `http-a-weird-filename-me` to be included in the snippet's
repository. As snippets are stored by ID, changing their filenames will not break
without a supported filename are renamed to a compatible format. For
example, if the snippet's filename is `http://a-weird-filename.me` it is
changed to `http-a-weird-filename-me` to be included in the snippet's
repository. As snippets are stored by ID, changing their filenames breaks
direct or embedded links to the snippet.
### Multiple files by Snippet
......@@ -151,7 +151,7 @@ see the documentation on [reducing repository size](../user/project/repository/r
- Creating or deleting branches is not supported. Only a default *master* branch is used.
- Git tags are not supported in snippet repositories.
- Snippets' repositories are limited to 10 files. Attempting to push more
than 10 files will result in an error.
than 10 files results in an error.
- Revisions are not *yet* visible to the user on the GitLab UI, but
it's planned to be added in future iterations. See the [revisions tab issue](https://gitlab.com/gitlab-org/gitlab/-/issues/39271)
for updates.
......@@ -187,9 +187,9 @@ facilitating the collaboration among users.
You can download the raw content of a snippet.
By default snippets will be downloaded with Linux-style line endings (`LF`). If
By default snippets are downloaded with Linux-style line endings (`LF`). If
you want to preserve the original line endings you need to add a parameter `line_ending=raw`
(e.g., `https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw`). In case a
(For example: `https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw`). In case a
snippet was created using the GitLab web interface the original line ending is Windows-like (`CRLF`).
## Embedded snippets
......@@ -207,7 +207,7 @@ To embed a snippet, first make sure that:
- In **Project > Settings > Permissions**, the snippets permissions are
set to **Everyone with access**
After the above conditions are met, the "Embed" section will appear in your
After the above conditions are met, the "Embed" section appears in your
snippet where you can simply click on the "Copy" button. This copies a one-line
script that you can add to any website or blog post.
......
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