Merge branch 'docs-gitlab-ci-dropdown' into 'master'
Add documentation on template dropdowns ## What does this MR do? Add docs for the dropdown template selectors /cc @axil See merge request !4865
|
@ -25,7 +25,3 @@ Add all the information that you'd like to include in your file:
|
|||
Add a commit message based on what you just added and then click on "commit changes":
|
||||
|
||||
![Commit changes](basicsimages/commit_changes.png)
|
||||
|
||||
### Note
|
||||
Besides its regular files, every directory needs a README.md or README.html file which works like an index, telling
|
||||
what the directory is about. It's the first document you'll find when you open a directory.
|
||||
|
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 65 KiB |
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 6.9 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 8.4 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 25 KiB |
After Width: | Height: | Size: 83 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
175
doc/user/project/repository/web_editor.md
Normal file
|
@ -0,0 +1,175 @@
|
|||
# GitLab Web Editor
|
||||
|
||||
Sometimes it's easier to make quick changes directly from the GitLab interface
|
||||
than to clone the project and use the Git command line tool. In this feature
|
||||
highlight we look at how you can create a new file, directory, branch or
|
||||
tag from the file browser. All of these actions are available from a single
|
||||
dropdown menu.
|
||||
|
||||
## Create a file
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch selector.
|
||||
Choose **New file** from the dropdown.
|
||||
|
||||
![New file dropdown menu](img/web_editor_new_file_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Enter a file name in the **File name** box. Then, add file content in the editor
|
||||
area. Add a descriptive commit message and choose a branch. The branch field
|
||||
will default to the branch you were viewing in the file browser. If you enter
|
||||
a new branch name, a checkbox will appear allowing you to start a new merge
|
||||
request after you commit the changes.
|
||||
|
||||
When you are satisfied with your new file, click **Commit Changes** at the bottom.
|
||||
|
||||
![Create file editor](img/web_editor_new_file_editor.png)
|
||||
|
||||
### Template dropdowns
|
||||
|
||||
When starting a new project, there are some common files which the new project
|
||||
might need too. Therefore a message will be displayed by GitLab to make this
|
||||
easy for you.
|
||||
|
||||
![First file for your project](img/web_editor_template_dropdown_first_file.png)
|
||||
|
||||
When clicking on either `LICENSE` or `.gitignore`, a dropdown will be displayed
|
||||
to provide you with a template which might be suitable for your project.
|
||||
|
||||
![MIT license selected](img/web_editor_template_dropdown_mit_license.png)
|
||||
|
||||
The license, changelog, contribution guide, or `.gitlab-ci.yml` file could also
|
||||
be added through a button on the project page. In the example below the license
|
||||
has already been created, which creates a link to the license itself.
|
||||
|
||||
![New file button](img/web_editor_template_dropdown_buttons.png)
|
||||
|
||||
>**Note:**
|
||||
The **Set up CI** button will not appear on an empty repository. You have to at
|
||||
least add a file in order for the button to show up.
|
||||
|
||||
## Upload a file
|
||||
|
||||
The ability to create a file is great when the content is text. However, this
|
||||
doesn't work well for binary data such as images, PDFs or other file types. In
|
||||
this case you need to upload a file.
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch
|
||||
selector. Choose **Upload file** from the dropdown.
|
||||
|
||||
![Upload file dropdown menu](img/web_editor_upload_file_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Once the upload dialog pops up there are two ways to upload your file. Either
|
||||
drag and drop a file on the pop up or use the **click to upload** link. A file
|
||||
preview will appear once you have selected a file to upload.
|
||||
|
||||
Enter a commit message, choose a branch, and click **Upload file** when you are
|
||||
ready.
|
||||
|
||||
![Upload file dialog](img/web_editor_upload_file_dialog.png)
|
||||
|
||||
## Create a directory
|
||||
|
||||
To keep files in the repository organized it is often helpful to create a new
|
||||
directory.
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch selector.
|
||||
Choose **New directory** from the dropdown.
|
||||
|
||||
![New directory dropdown](img/web_editor_new_directory_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
In the new directory dialog enter a directory name, a commit message and choose
|
||||
the target branch. Click **Create directory** to finish.
|
||||
|
||||
![New directory dialog](img/web_editor_new_directory_dialog.png)
|
||||
|
||||
## Create a new branch
|
||||
|
||||
There are multiple ways to create a branch from GitLab's web interface.
|
||||
|
||||
### Create a new branch from an issue
|
||||
|
||||
> [Introduced][ce-2808] in GitLab 8.6.
|
||||
|
||||
In case your development workflow dictates to have an issue for every merge
|
||||
request, you can quickly create a branch right on the issue page which will be
|
||||
tied with the issue itself. You can see a **New Branch** button after the issue
|
||||
description, unless there is already a branch with the same name or a referenced
|
||||
merge request.
|
||||
|
||||
![New Branch Button](img/new_branch_from_issue.png)
|
||||
|
||||
Once you click it, a new branch will be created that diverges from the default
|
||||
branch of your project, by default `master`. The branch name will be based on
|
||||
the title of the issue and as suffix it will have its ID. Thus, the example
|
||||
screenshot above will yield a branch named
|
||||
`2-et-cum-et-sed-expedita-repellat-consequatur-ut-assumenda-numquam-rerum`.
|
||||
|
||||
After the branch is created, you can edit files in the repository to fix
|
||||
the issue. When a merge request is created based on the newly created branch,
|
||||
the description field will automatically display the [issue closing pattern]
|
||||
`Closes #ID`, where `ID` the ID of the issue. This will close the issue once the
|
||||
merge request is merged.
|
||||
|
||||
### Create a new branch from a project's dashboard
|
||||
|
||||
If you want to make changes to several files before creating a new merge
|
||||
request, you can create a new branch up front. From a project's files page,
|
||||
choose **New branch** from the dropdown.
|
||||
|
||||
![New branch dropdown](img/web_editor_new_branch_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Enter a new **Branch name**. Optionally, change the **Create from** field
|
||||
to choose which branch, tag or commit SHA this new branch will originate from.
|
||||
This field will autocomplete if you start typing an existing branch or tag.
|
||||
Click **Create branch** and you will be returned to the file browser on this new
|
||||
branch.
|
||||
|
||||
![New branch page](img/web_editor_new_branch_page.png)
|
||||
|
||||
---
|
||||
|
||||
You can now make changes to any files, as needed. When you're ready to merge
|
||||
the changes back to master you can use the widget at the top of the screen.
|
||||
This widget only appears for a period of time after you create the branch or
|
||||
modify files.
|
||||
|
||||
![New push widget](img/web_editor_new_push_widget.png)
|
||||
|
||||
## Create a new tag
|
||||
|
||||
Tags are useful for marking major milestones such as production releases,
|
||||
release candidates, and more. You can create a tag from a branch or a commit
|
||||
SHA. From a project's files page, choose **New tag** from the dropdown.
|
||||
|
||||
![New tag dropdown](img/web_editor_new_tag_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Give the tag a name such as `v1.0.0`. Choose the branch or SHA from which you
|
||||
would like to create this new tag. You can optionally add a message and
|
||||
release notes. The release notes section supports markdown format and you can
|
||||
also upload an attachment. Click **Create tag** and you will be taken to the tag
|
||||
list page.
|
||||
|
||||
![New tag page](img/web_editor_new_tag_page.png)
|
||||
|
||||
## Tips
|
||||
|
||||
When creating or uploading a new file, or creating a new directory, you can
|
||||
trigger a new merge request rather than committing directly to master. Enter
|
||||
a new branch name in the **Target branch** field. You will notice a checkbox
|
||||
appear that is labeled **Start a new merge request with these changes**. After
|
||||
you commit the changes you will be taken to a new merge request form.
|
||||
|
||||
![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png)
|
||||
|
||||
![New file button](basicsimages/file_button.png)
|
||||
[ce-2808]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2808
|
||||
[issue closing pattern]: ../customization/issue_closing.md
|
|
@ -18,7 +18,7 @@
|
|||
- [Slash commands](../user/project/slash_commands.md)
|
||||
- [Sharing a project with a group](share_with_group.md)
|
||||
- [Share projects with other groups](share_projects_with_other_groups.md)
|
||||
- [Web Editor](web_editor.md)
|
||||
- [Web Editor](../user/project/repository/web_editor.md)
|
||||
- [Releases](releases.md)
|
||||
- [Milestones](milestones.md)
|
||||
- [Merge Requests](merge_requests.md)
|
||||
|
|
|
@ -1,151 +1 @@
|
|||
# GitLab Web Editor
|
||||
|
||||
Sometimes it's easier to make quick changes directly from the GitLab interface
|
||||
than to clone the project and use the Git command line tool. In this feature
|
||||
highlight we look at how you can create a new file, directory, branch or
|
||||
tag from the file browser. All of these actions are available from a single
|
||||
dropdown menu.
|
||||
|
||||
## Create a file
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch selector.
|
||||
Choose **New file** from the dropdown.
|
||||
|
||||
![New file dropdown menu](img/web_editor_new_file_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Enter a file name in the **File name** box. Then, add file content in the editor
|
||||
area. Add a descriptive commit message and choose a branch. The branch field
|
||||
will default to the branch you were viewing in the file browser. If you enter
|
||||
a new branch name, a checkbox will appear allowing you to start a new merge
|
||||
request after you commit the changes.
|
||||
|
||||
When you are satisfied with your new file, click **Commit Changes** at the bottom.
|
||||
|
||||
![Create file editor](img/web_editor_new_file_editor.png)
|
||||
|
||||
## Upload a file
|
||||
|
||||
The ability to create a file is great when the content is text. However, this
|
||||
doesn't work well for binary data such as images, PDFs or other file types. In
|
||||
this case you need to upload a file.
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch
|
||||
selector. Choose **Upload file** from the dropdown.
|
||||
|
||||
![Upload file dropdown menu](img/web_editor_upload_file_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Once the upload dialog pops up there are two ways to upload your file. Either
|
||||
drag and drop a file on the pop up or use the **click to upload** link. A file
|
||||
preview will appear once you have selected a file to upload.
|
||||
|
||||
Enter a commit message, choose a branch, and click **Upload file** when you are
|
||||
ready.
|
||||
|
||||
![Upload file dialog](img/web_editor_upload_file_dialog.png)
|
||||
|
||||
## Create a directory
|
||||
|
||||
To keep files in the repository organized it is often helpful to create a new
|
||||
directory.
|
||||
|
||||
From a project's files page, click the '+' button to the right of the branch selector.
|
||||
Choose **New directory** from the dropdown.
|
||||
|
||||
![New directory dropdown](img/web_editor_new_directory_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
In the new directory dialog enter a directory name, a commit message and choose
|
||||
the target branch. Click **Create directory** to finish.
|
||||
|
||||
![New directory dialog](img/web_editor_new_directory_dialog.png)
|
||||
|
||||
## Create a new branch
|
||||
|
||||
There are multiple ways to create a branch from GitLab's web interface.
|
||||
|
||||
### Create a new branch from an issue
|
||||
|
||||
> [Introduced][ce-2808] in GitLab 8.6.
|
||||
|
||||
In case your development workflow dictates to have an issue for every merge
|
||||
request, you can quickly create a branch right on the issue page which will be
|
||||
tied with the issue itself. You can see a **New Branch** button after the issue
|
||||
description, unless there is already a branch with the same name or a referenced
|
||||
merge request.
|
||||
|
||||
![New Branch Button](img/new_branch_from_issue.png)
|
||||
|
||||
Once you click it, a new branch will be created that diverges from the default
|
||||
branch of your project, by default `master`. The branch name will be based on
|
||||
the title of the issue and as suffix it will have its ID. Thus, the example
|
||||
screenshot above will yield a branch named
|
||||
`2-et-cum-et-sed-expedita-repellat-consequatur-ut-assumenda-numquam-rerum`.
|
||||
|
||||
After the branch is created, you can edit files in the repository to fix
|
||||
the issue. When a merge request is created based on the newly created branch,
|
||||
the description field will automatically display the [issue closing pattern]
|
||||
`Closes #ID`, where `ID` the ID of the issue. This will close the issue once the
|
||||
merge request is merged.
|
||||
|
||||
### Create a new branch from a project's dashboard
|
||||
|
||||
If you want to make changes to several files before creating a new merge
|
||||
request, you can create a new branch up front. From a project's files page,
|
||||
choose **New branch** from the dropdown.
|
||||
|
||||
![New branch dropdown](img/web_editor_new_branch_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Enter a new **Branch name**. Optionally, change the **Create from** field
|
||||
to choose which branch, tag or commit SHA this new branch will originate from.
|
||||
This field will autocomplete if you start typing an existing branch or tag.
|
||||
Click **Create branch** and you will be returned to the file browser on this new
|
||||
branch.
|
||||
|
||||
![New branch page](img/web_editor_new_branch_page.png)
|
||||
|
||||
---
|
||||
|
||||
You can now make changes to any files, as needed. When you're ready to merge
|
||||
the changes back to master you can use the widget at the top of the screen.
|
||||
This widget only appears for a period of time after you create the branch or
|
||||
modify files.
|
||||
|
||||
![New push widget](img/web_editor_new_push_widget.png)
|
||||
|
||||
## Create a new tag
|
||||
|
||||
Tags are useful for marking major milestones such as production releases,
|
||||
release candidates, and more. You can create a tag from a branch or a commit
|
||||
SHA. From a project's files page, choose **New tag** from the dropdown.
|
||||
|
||||
![New tag dropdown](img/web_editor_new_tag_dropdown.png)
|
||||
|
||||
---
|
||||
|
||||
Give the tag a name such as `v1.0.0`. Choose the branch or SHA from which you
|
||||
would like to create this new tag. You can optionally add a message and
|
||||
release notes. The release notes section supports markdown format and you can
|
||||
also upload an attachment. Click **Create tag** and you will be taken to the tag
|
||||
list page.
|
||||
|
||||
![New tag page](img/web_editor_new_tag_page.png)
|
||||
|
||||
## Tips
|
||||
|
||||
When creating or uploading a new file, or creating a new directory, you can
|
||||
trigger a new merge request rather than committing directly to master. Enter
|
||||
a new branch name in the **Target branch** field. You will notice a checkbox
|
||||
appear that is labeled **Start a new merge request with these changes**. After
|
||||
you commit the changes you will be taken to a new merge request form.
|
||||
|
||||
![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png)
|
||||
|
||||
[ce-2808]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2808
|
||||
[issue closing pattern]: ../customization/issue_closing.md
|
||||
This document was moved to [user/project/repository/web_editor](../user/project/repository/web_editor.md).
|
||||
|
|