From 30b56b160b854baf03bfacd80c0e87d62716dd0f Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Fri, 2 Sep 2016 13:11:57 +0200 Subject: Move web_editor doc to new location --- .../img/web_editor_new_branch_dropdown.png | Bin 0 -> 20436 bytes .../repository/img/web_editor_new_branch_page.png | Bin 0 -> 11245 bytes .../img/web_editor_new_directory_dialog.png | Bin 0 -> 13339 bytes .../img/web_editor_new_directory_dropdown.png | Bin 0 -> 20007 bytes .../img/web_editor_new_file_dropdown.png | Bin 0 -> 20680 bytes .../repository/img/web_editor_new_file_editor.png | Bin 0 -> 66261 bytes .../repository/img/web_editor_new_push_widget.png | Bin 0 -> 7076 bytes .../repository/img/web_editor_new_tag_dropdown.png | Bin 0 -> 20080 bytes .../repository/img/web_editor_new_tag_page.png | Bin 0 -> 36610 bytes .../img/web_editor_start_new_merge_request.png | Bin 0 -> 8596 bytes .../img/web_editor_upload_file_dialog.png | Bin 0 -> 21502 bytes .../img/web_editor_upload_file_dropdown.png | Bin 0 -> 20651 bytes doc/user/project/repository/web_editor.md | 151 ++++++++++++++++++++ doc/workflow/README.md | 2 +- .../img/web_editor_new_branch_dropdown.png | Bin 20436 -> 0 bytes doc/workflow/img/web_editor_new_branch_page.png | Bin 11245 -> 0 bytes .../img/web_editor_new_directory_dialog.png | Bin 13339 -> 0 bytes .../img/web_editor_new_directory_dropdown.png | Bin 20007 -> 0 bytes doc/workflow/img/web_editor_new_file_dropdown.png | Bin 20680 -> 0 bytes doc/workflow/img/web_editor_new_file_editor.png | Bin 66261 -> 0 bytes doc/workflow/img/web_editor_new_push_widget.png | Bin 7076 -> 0 bytes doc/workflow/img/web_editor_new_tag_dropdown.png | Bin 20080 -> 0 bytes doc/workflow/img/web_editor_new_tag_page.png | Bin 36610 -> 0 bytes .../img/web_editor_start_new_merge_request.png | Bin 8596 -> 0 bytes doc/workflow/img/web_editor_upload_file_dialog.png | Bin 21502 -> 0 bytes .../img/web_editor_upload_file_dropdown.png | Bin 20651 -> 0 bytes doc/workflow/web_editor.md | 152 +-------------------- 27 files changed, 153 insertions(+), 152 deletions(-) create mode 100644 doc/user/project/repository/img/web_editor_new_branch_dropdown.png create mode 100644 doc/user/project/repository/img/web_editor_new_branch_page.png create mode 100644 doc/user/project/repository/img/web_editor_new_directory_dialog.png create mode 100644 doc/user/project/repository/img/web_editor_new_directory_dropdown.png create mode 100644 doc/user/project/repository/img/web_editor_new_file_dropdown.png create mode 100644 doc/user/project/repository/img/web_editor_new_file_editor.png create mode 100644 doc/user/project/repository/img/web_editor_new_push_widget.png create mode 100644 doc/user/project/repository/img/web_editor_new_tag_dropdown.png create mode 100644 doc/user/project/repository/img/web_editor_new_tag_page.png create mode 100644 doc/user/project/repository/img/web_editor_start_new_merge_request.png create mode 100644 doc/user/project/repository/img/web_editor_upload_file_dialog.png create mode 100644 doc/user/project/repository/img/web_editor_upload_file_dropdown.png create mode 100644 doc/user/project/repository/web_editor.md delete mode 100644 doc/workflow/img/web_editor_new_branch_dropdown.png delete mode 100644 doc/workflow/img/web_editor_new_branch_page.png delete mode 100644 doc/workflow/img/web_editor_new_directory_dialog.png delete mode 100644 doc/workflow/img/web_editor_new_directory_dropdown.png delete mode 100644 doc/workflow/img/web_editor_new_file_dropdown.png delete mode 100644 doc/workflow/img/web_editor_new_file_editor.png delete mode 100644 doc/workflow/img/web_editor_new_push_widget.png delete mode 100644 doc/workflow/img/web_editor_new_tag_dropdown.png delete mode 100644 doc/workflow/img/web_editor_new_tag_page.png delete mode 100644 doc/workflow/img/web_editor_start_new_merge_request.png delete mode 100644 doc/workflow/img/web_editor_upload_file_dialog.png delete mode 100644 doc/workflow/img/web_editor_upload_file_dropdown.png (limited to 'doc') diff --git a/doc/user/project/repository/img/web_editor_new_branch_dropdown.png b/doc/user/project/repository/img/web_editor_new_branch_dropdown.png new file mode 100644 index 00000000000..a8e635d2faf Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_branch_dropdown.png differ diff --git a/doc/user/project/repository/img/web_editor_new_branch_page.png b/doc/user/project/repository/img/web_editor_new_branch_page.png new file mode 100644 index 00000000000..7f36b7faf63 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_branch_page.png differ diff --git a/doc/user/project/repository/img/web_editor_new_directory_dialog.png b/doc/user/project/repository/img/web_editor_new_directory_dialog.png new file mode 100644 index 00000000000..d16e3c67116 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_directory_dialog.png differ diff --git a/doc/user/project/repository/img/web_editor_new_directory_dropdown.png b/doc/user/project/repository/img/web_editor_new_directory_dropdown.png new file mode 100644 index 00000000000..c8d77b16ee8 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_directory_dropdown.png differ diff --git a/doc/user/project/repository/img/web_editor_new_file_dropdown.png b/doc/user/project/repository/img/web_editor_new_file_dropdown.png new file mode 100644 index 00000000000..3fcb91c9b93 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_file_dropdown.png differ diff --git a/doc/user/project/repository/img/web_editor_new_file_editor.png b/doc/user/project/repository/img/web_editor_new_file_editor.png new file mode 100644 index 00000000000..21c340b9288 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_file_editor.png differ diff --git a/doc/user/project/repository/img/web_editor_new_push_widget.png b/doc/user/project/repository/img/web_editor_new_push_widget.png new file mode 100644 index 00000000000..c7738a4c930 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_push_widget.png differ diff --git a/doc/user/project/repository/img/web_editor_new_tag_dropdown.png b/doc/user/project/repository/img/web_editor_new_tag_dropdown.png new file mode 100644 index 00000000000..ac7415009b3 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_tag_dropdown.png differ diff --git a/doc/user/project/repository/img/web_editor_new_tag_page.png b/doc/user/project/repository/img/web_editor_new_tag_page.png new file mode 100644 index 00000000000..231e1a13fc0 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_new_tag_page.png differ diff --git a/doc/user/project/repository/img/web_editor_start_new_merge_request.png b/doc/user/project/repository/img/web_editor_start_new_merge_request.png new file mode 100644 index 00000000000..2755501dfd1 Binary files /dev/null and b/doc/user/project/repository/img/web_editor_start_new_merge_request.png differ diff --git a/doc/user/project/repository/img/web_editor_upload_file_dialog.png b/doc/user/project/repository/img/web_editor_upload_file_dialog.png new file mode 100644 index 00000000000..9d6d8250bbe Binary files /dev/null and b/doc/user/project/repository/img/web_editor_upload_file_dialog.png differ diff --git a/doc/user/project/repository/img/web_editor_upload_file_dropdown.png b/doc/user/project/repository/img/web_editor_upload_file_dropdown.png new file mode 100644 index 00000000000..6b5205b05ec Binary files /dev/null and b/doc/user/project/repository/img/web_editor_upload_file_dropdown.png differ diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md new file mode 100644 index 00000000000..ee8e7862572 --- /dev/null +++ b/doc/user/project/repository/web_editor.md @@ -0,0 +1,151 @@ +# 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 diff --git a/doc/workflow/README.md b/doc/workflow/README.md index 0cf56449de2..fe13bd757c5 100644 --- a/doc/workflow/README.md +++ b/doc/workflow/README.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) diff --git a/doc/workflow/img/web_editor_new_branch_dropdown.png b/doc/workflow/img/web_editor_new_branch_dropdown.png deleted file mode 100644 index a8e635d2faf..00000000000 Binary files a/doc/workflow/img/web_editor_new_branch_dropdown.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_branch_page.png b/doc/workflow/img/web_editor_new_branch_page.png deleted file mode 100644 index 7f36b7faf63..00000000000 Binary files a/doc/workflow/img/web_editor_new_branch_page.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_directory_dialog.png b/doc/workflow/img/web_editor_new_directory_dialog.png deleted file mode 100644 index d16e3c67116..00000000000 Binary files a/doc/workflow/img/web_editor_new_directory_dialog.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_directory_dropdown.png b/doc/workflow/img/web_editor_new_directory_dropdown.png deleted file mode 100644 index c8d77b16ee8..00000000000 Binary files a/doc/workflow/img/web_editor_new_directory_dropdown.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_file_dropdown.png b/doc/workflow/img/web_editor_new_file_dropdown.png deleted file mode 100644 index 3fcb91c9b93..00000000000 Binary files a/doc/workflow/img/web_editor_new_file_dropdown.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_file_editor.png b/doc/workflow/img/web_editor_new_file_editor.png deleted file mode 100644 index 21c340b9288..00000000000 Binary files a/doc/workflow/img/web_editor_new_file_editor.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_push_widget.png b/doc/workflow/img/web_editor_new_push_widget.png deleted file mode 100644 index c7738a4c930..00000000000 Binary files a/doc/workflow/img/web_editor_new_push_widget.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_tag_dropdown.png b/doc/workflow/img/web_editor_new_tag_dropdown.png deleted file mode 100644 index ac7415009b3..00000000000 Binary files a/doc/workflow/img/web_editor_new_tag_dropdown.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_new_tag_page.png b/doc/workflow/img/web_editor_new_tag_page.png deleted file mode 100644 index 231e1a13fc0..00000000000 Binary files a/doc/workflow/img/web_editor_new_tag_page.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_start_new_merge_request.png b/doc/workflow/img/web_editor_start_new_merge_request.png deleted file mode 100644 index 2755501dfd1..00000000000 Binary files a/doc/workflow/img/web_editor_start_new_merge_request.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_upload_file_dialog.png b/doc/workflow/img/web_editor_upload_file_dialog.png deleted file mode 100644 index 9d6d8250bbe..00000000000 Binary files a/doc/workflow/img/web_editor_upload_file_dialog.png and /dev/null differ diff --git a/doc/workflow/img/web_editor_upload_file_dropdown.png b/doc/workflow/img/web_editor_upload_file_dropdown.png deleted file mode 100644 index 6b5205b05ec..00000000000 Binary files a/doc/workflow/img/web_editor_upload_file_dropdown.png and /dev/null differ diff --git a/doc/workflow/web_editor.md b/doc/workflow/web_editor.md index ee8e7862572..595c7da155b 100644 --- a/doc/workflow/web_editor.md +++ b/doc/workflow/web_editor.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). -- cgit v1.2.1