Commit 6128fc76 authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-aqualls-create-future-tense' into 'master'

Create docset, future tense cleanup (1)

See merge request gitlab-org/gitlab!55876
parents 01a0d39e 42ee27f7
......@@ -488,7 +488,7 @@ POST /namespaces/:id/gitlab_subscription
| `plan_code` | string | no | Subscription tier code |
| `seats` | integer | no | Number of seats in subscription |
| `max_seats_used` | integer | no | Highest number of active users in the last month |
| `auto_renew` | boolean | no | Whether subscription will auto renew on end date |
| `auto_renew` | boolean | no | Whether subscription auto-renews on end date |
| `trial` | boolean | no | Whether subscription is a trial |
| `trial_starts_on` | date | no | Start date of trial |
| `trial_ends_on` | date | no | End date of trial |
......@@ -539,7 +539,7 @@ PUT /namespaces/:id/gitlab_subscription
| `plan_code` | string | no | Subscription tier code |
| `seats` | integer | no | Number of seats in subscription |
| `max_seats_used` | integer | no | Highest number of active users in the last month |
| `auto_renew` | boolean | no | Whether subscription will auto renew on end date |
| `auto_renew` | boolean | no | Whether subscription auto-renews on end date |
| `trial` | boolean | no | Whether subscription is a trial |
| `trial_starts_on` | date | no | Start date of trial. Required if trial is true. |
| `trial_ends_on` | date | no | End date of trial |
......
......@@ -23,7 +23,7 @@ select the project to serve as the custom template repository.
![File templates in the Admin Area](img/file_template_admin_area.png)
After that, you can add custom templates to the selected repository and use them for the entire instance.
They will be available on the [Web Editor's dropdown](../../project/repository/web_editor.md#template-dropdowns)
They are available in the [Web Editor's dropdown](../../project/repository/web_editor.md#template-dropdowns)
and through the [API settings](../../../api/settings.md).
Templates must be added to a specific subdirectory in the repository,
......@@ -60,12 +60,12 @@ extension and not be empty. So, the hierarchy should look like this:
|-- another_metrics-dashboard.yml
```
Your custom templates will be displayed on the dropdown menu when a new file is added through the GitLab UI:
Your custom templates are displayed on the dropdown menu when a new file is added through the GitLab UI:
![Custom template dropdown menu](img/file_template_user_dropdown.png)
If this feature is disabled or no templates are present, there will be
no "Custom" section in the selection dropdown.
If this feature is disabled or no templates are present,
no **Custom** section displays in the selection dropdown.
<!-- ## Troubleshooting
......
......@@ -14,7 +14,7 @@ allowed at once. If the number of events is greater than this, GitLab creates
bulk push event instead.
For example, if 4 branches are pushed and the limit is currently set to 3,
you'll see the following in the activity feed:
the activity feed displays:
![Bulk push event](img/bulk_push_event_v12_4.png)
......
......@@ -30,7 +30,7 @@ Line comments, which are lines that start with `//`, are skipped:
A blank line separates paragraphs.
A paragraph with the `[%hardbreaks]` option will preserve line breaks:
A paragraph with the `[%hardbreaks]` option preserves line breaks:
```plaintext
[%hardbreaks]
......@@ -381,7 +381,7 @@ Supported formats (named colors are not supported):
- RGB: `` `RGB[A](R, G, B[, A])` ``
- HSL: `` `HSL[A](H, S, L[, A])` ``
Color written inside backticks will be followed by a color "chip":
Color written inside backticks is followed by a color "chip":
```plaintext
- `#F00`
......@@ -399,7 +399,7 @@ Color written inside backticks will be followed by a color "chip":
To activate equation and formula support,
set the `stem` attribute in the document's header to `latexmath`.
Equations and formulas will be rendered using [KaTeX](https://katex.org/):
Equations and formulas are rendered using [KaTeX](https://katex.org/):
```plaintext
:stem: latexmath
......
......@@ -64,7 +64,7 @@ against accidental deletion and forced pushes.
By default, when you create a new project in GitLab, the initial branch is called `master`.
For self-managed instances, a GitLab administrator can customize the initial branch name to something
else. This way, every new project created from then on will start from the custom branch name rather than `master`. To do so:
else. This way, every new project created from then on starts from the custom branch name rather than `master`. To do so:
1. Go to the **Admin Area > Settings > Repository** and expand **Default initial
branch name**.
......@@ -108,7 +108,7 @@ To compare branches in a repository:
![Delete merged branches](img/delete_merged_branches.png)
This feature allows merged branches to be deleted in bulk. Only branches that
have been merged and [are not protected](../../protected_branches.md) will be deleted as part of
have been merged and [are not protected](../../protected_branches.md) are deleted as part of
this operation.
It's particularly useful to clean up old branches that were not deleted
......@@ -127,8 +127,8 @@ This feature allows you to search and select branches quickly. Search results ap
Sometimes when you have hundreds of branches you may want a more flexible matching pattern. In such cases you can use the following:
- `^feature` will only match branch names that begin with 'feature'.
- `feature$` will only match branch names that end with 'feature'.
- `^feature` matches only branch names that begin with 'feature'.
- `feature$` matches only branch names that end with 'feature'.
<!-- ## Troubleshooting
......
......@@ -18,13 +18,12 @@ You can find the **Blame** button with each file in a project.
![File blame button](img/file_blame_button_v12_6.png "Blame button")
When you select the **Blame** button, you'll see a screen with the
noted information:
When you select the **Blame** button, this information is shown:
![Git blame output](img/file_blame_output_v12_6.png "Blame button output")
If you hover over a commit in the UI, you'll see a precise date and time
for that commit.
If you hover over a commit in the UI, the commit's precise date and time
are shown.
## Blame previous commit
......@@ -45,7 +44,7 @@ about a `README.md` file in the local directory, run the following command:
git blame README.md
```
You'll see output similar to the following, which includes the commit time
The output looks similar to the following, which includes the commit time
in UTC format:
```shell
......
......@@ -19,8 +19,8 @@ To create a new repository, all you need to do is
Once you create a new project, you can add new files via UI
(read the section below) or via command line.
To add files from the command line, follow the instructions that will
be presented on the screen when you create a new project, or read
To add files from the command line, follow the instructions
presented on the screen when you create a new project, or read
through them in the [command line basics](../../../gitlab-basics/start-using-git.md)
documentation.
......@@ -31,8 +31,7 @@ that you [connect with GitLab via SSH](../../../ssh/README.md).
## Files
Use a repository to store your files in GitLab. In [GitLab 12.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/33806),
you'll see on the repository's file tree an icon next to the filename
according to its extension:
an icon identifying the extension is shown next to the filename:
![Repository file icons](img/file_ext_icons_repo_v12_10.png)
......@@ -76,7 +75,7 @@ markup languages](https://en.wikipedia.org/wiki/Lightweight_markup_language))
that you can use for the content of your files in a repository. They are mostly
used for documentation purposes.
Just pick the right extension for your files and GitLab will render them
Just pick the right extension for your files and GitLab renders them
according to the markup language.
| Markup language | Extensions |
......@@ -93,7 +92,7 @@ according to the markup language.
### Repository README and index files
When a `README` or `index` file is present in a repository, its contents will be
When a `README` or `index` file is present in a repository, its contents are
automatically pre-rendered by GitLab without opening it.
They can either be plain text or have an extension of a
......@@ -101,12 +100,12 @@ They can either be plain text or have an extension of a
Some things to note about precedence:
1. When both a `README` and an `index` file are present, the `README` will always
take precedence.
1. When both a `README` and an `index` file are present, the `README` always
takes precedence.
1. When more than one file is present with different extensions, they are
ordered alphabetically, with the exception of a file without an extension
which will always be last in precedence. For example, `README.adoc` will take
precedence over `README.md`, and `README.rst` will take precedence over
ordered alphabetically, with the exception of a file without an extension,
which is always last in precedence. For example, `README.adoc` takes
precedence over `README.md`, and `README.rst` takes precedence over
`README`.
### Jupyter Notebook files
......@@ -159,18 +158,18 @@ Via command line, you can commit multiple times before pushing.
- **Commit message:**
A commit message is important to identity what is being changed and,
more importantly, why. In GitLab, you can add keywords to the commit
message that will perform one of the actions below:
message that performs one of the actions below:
- **Trigger a GitLab CI/CD pipeline:**
If you have your project configured with [GitLab CI/CD](../../../ci/README.md),
you will trigger a pipeline per push, not per commit.
you trigger a pipeline per push, not per commit.
- **Skip pipelines:**
You can add to you commit message the keyword
[`[ci skip]`](../../../ci/yaml/README.md#skip-pipeline)
and GitLab CI/CD will skip that pipeline.
You can add to your commit message the keyword
[`[ci skip]`](../../../ci/yaml/README.md#skip-pipeline),
and GitLab CI/CD skips that pipeline.
- **Cross-link issues and merge requests:**
[Cross-linking](../issues/crosslinking_issues.md#from-commit-messages)
is great to keep track of what's is somehow related in your workflow.
If you mention an issue or a merge request in a commit message, they will be shown
If you mention an issue or a merge request in a commit message, they are shown
on their respective thread.
- **Cherry-pick a commit:**
In GitLab, you can
......@@ -211,9 +210,9 @@ Find it under your project's **Repository > Graph**.
## Repository Languages
For the default branch of each repository, GitLab will determine what programming languages
were used and display this on the projects pages. If this information is missing, it will
be added after updating the default branch on the project. This process can take up to 5
For the default branch of each repository, GitLab determines what programming languages
were used and displays this on the project's pages. If this information is missing, it's
added after updating the default branch for the project. This process can take up to five
minutes.
![Repository Languages bar](img/repository_languages_v12_2.gif)
......@@ -253,8 +252,8 @@ into Xcode on macOS. To do that:
1. Click **Clone**.
1. Select **Xcode**.
The project will be cloned onto your computer in a folder of your choice and you'll
be prompted to open in XCode.
The project is cloned onto your computer in a folder of your choice and you are
prompted to open XCode.
### Clone and open in Visual Studio Code
......@@ -264,10 +263,10 @@ All projects can be cloned into Visual Studio Code. To do that:
1. From the GitLab UI, go to the project's overview page.
1. Click **Clone**.
1. Select **VS Code**
1. Select **VS Code**.
1. Select a folder to clone the project into.
You'll be prompted to select a folder to clone the project into. When VS Code has
successfully cloned your project, it will open the folder.
When VS Code has successfully cloned your project, it opens the folder.
## Download Source Code
......@@ -275,7 +274,7 @@ successfully cloned your project, it will open the folder.
> - Support for [including Git LFS blobs](../../../topics/git/lfs#lfs-objects-in-project-archives) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15079) in GitLab 13.5.
The source code stored in a repository can be downloaded from the UI.
By clicking the download icon, a dropdown will open with links to download the following:
By clicking the download icon, a dropdown opens with links to download the following:
![Download source code](img/download_source_code.png)
......
......@@ -12,12 +12,12 @@ type: reference
interactive computing in many fields and contain a complete record of the
user's sessions and include code, narrative text, equations, and rich output.
When added to a repository, Jupyter Notebooks with a `.ipynb` extension will be
When added to a repository, Jupyter Notebooks with a `.ipynb` extension are
rendered to HTML when viewed.
![Jupyter Notebook Rich Output](img/jupyter_notebook.png)
Interactive features, including JavaScript plots, will not work when viewed in
Interactive features, including JavaScript plots, don't work when viewed in
GitLab.
## Jupyter Hub as a GitLab Managed App
......
......@@ -103,8 +103,7 @@ Some features depend on others:
When the **Issues** option is disabled, you can still access **Milestones**
from merge requests.
- Additionally, if you disable both **Issues** and **Merge Requests**, you will no
longer have access to:
- Additionally, if you disable both **Issues** and **Merge Requests**, you cannot access:
- **Labels**
- **Milestones**
......@@ -220,7 +219,7 @@ To rename a repository:
1. Click **Change path**.
Remember that this can have unintended side effects since everyone with the
old URL won't be able to push or pull. Read more about what happens with the
old URL can't push or pull. Read more about what happens with the
[redirects when renaming repositories](../repository/index.md#redirects-when-changing-repository-paths).
#### Transferring an existing project into another namespace
......@@ -243,7 +242,7 @@ To transfer a project:
project to.
1. Confirm the transfer by typing the project's path as instructed.
Once done, you will be taken to the new project's namespace. At this point,
Once done, you are redirected to the new project's namespace. At this point,
read what happens with the
[redirects from the old project to the new one](../repository/index.md#redirects-when-changing-repository-paths).
......@@ -293,7 +292,7 @@ If you want to use the fork for yourself and don't need to send
you can safely remove the fork relationship.
WARNING:
Once removed, the fork relationship cannot be restored. You will no longer be able to send merge requests to the source, and if anyone has forked your project, their fork will also lose the relationship.
Once removed, the fork relationship cannot be restored. You can't send merge requests to the source, and if anyone has forked your project, their fork also loses the relationship.
To do so:
......
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