diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-02-10 16:42:30 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-02-10 16:46:19 +0200 |
| commit | f9982d58224d813b2f8f721ff504aaa392eb0d11 (patch) | |
| tree | 6c31034860bbe8188b5406e20eecc4604826b1a5 | |
| parent | 10aa99a30c311c59358d1547ebcbe0f6a92227a7 (diff) | |
| download | gitlab-ce-web_editor.tar.gz | |
Update web editor documentationweb_editor
Based on https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/1045
[ci skip]
17 files changed, 110 insertions, 16 deletions
diff --git a/doc/workflow/img/web_editor_new_branch_dropdown.png b/doc/workflow/img/web_editor_new_branch_dropdown.png Binary files differnew file mode 100644 index 00000000000..009e4b05adf --- /dev/null +++ b/doc/workflow/img/web_editor_new_branch_dropdown.png diff --git a/doc/workflow/img/web_editor_new_branch_page.png b/doc/workflow/img/web_editor_new_branch_page.png Binary files differnew file mode 100644 index 00000000000..dd6cfc6e7bb --- /dev/null +++ b/doc/workflow/img/web_editor_new_branch_page.png diff --git a/doc/workflow/img/web_editor_new_directory_dialog.png b/doc/workflow/img/web_editor_new_directory_dialog.png Binary files differnew file mode 100644 index 00000000000..2c76f84f395 --- /dev/null +++ b/doc/workflow/img/web_editor_new_directory_dialog.png diff --git a/doc/workflow/img/web_editor_new_directory_dropdown.png b/doc/workflow/img/web_editor_new_directory_dropdown.png Binary files differnew file mode 100644 index 00000000000..cedf46aedfd --- /dev/null +++ b/doc/workflow/img/web_editor_new_directory_dropdown.png diff --git a/doc/workflow/img/web_editor_new_file_dropdown.png b/doc/workflow/img/web_editor_new_file_dropdown.png Binary files differnew file mode 100644 index 00000000000..6e884f6504d --- /dev/null +++ b/doc/workflow/img/web_editor_new_file_dropdown.png diff --git a/doc/workflow/img/web_editor_new_file_editor.png b/doc/workflow/img/web_editor_new_file_editor.png Binary files differnew file mode 100644 index 00000000000..c76473bcfa7 --- /dev/null +++ b/doc/workflow/img/web_editor_new_file_editor.png diff --git a/doc/workflow/img/web_editor_new_push_widget.png b/doc/workflow/img/web_editor_new_push_widget.png Binary files differnew file mode 100644 index 00000000000..a2108735741 --- /dev/null +++ b/doc/workflow/img/web_editor_new_push_widget.png diff --git a/doc/workflow/img/web_editor_new_tag_dropdown.png b/doc/workflow/img/web_editor_new_tag_dropdown.png Binary files differnew file mode 100644 index 00000000000..263dd635b95 --- /dev/null +++ b/doc/workflow/img/web_editor_new_tag_dropdown.png diff --git a/doc/workflow/img/web_editor_new_tag_page.png b/doc/workflow/img/web_editor_new_tag_page.png Binary files differnew file mode 100644 index 00000000000..64d7cd11ed1 --- /dev/null +++ b/doc/workflow/img/web_editor_new_tag_page.png diff --git a/doc/workflow/img/web_editor_start_new_merge_request.png b/doc/workflow/img/web_editor_start_new_merge_request.png Binary files differnew file mode 100644 index 00000000000..be12a151cac --- /dev/null +++ b/doc/workflow/img/web_editor_start_new_merge_request.png diff --git a/doc/workflow/img/web_editor_upload_file_dialog.png b/doc/workflow/img/web_editor_upload_file_dialog.png Binary files differnew file mode 100644 index 00000000000..6dd2207bca0 --- /dev/null +++ b/doc/workflow/img/web_editor_upload_file_dialog.png diff --git a/doc/workflow/img/web_editor_upload_file_dropdown.png b/doc/workflow/img/web_editor_upload_file_dropdown.png Binary files differnew file mode 100644 index 00000000000..bf6528701b0 --- /dev/null +++ b/doc/workflow/img/web_editor_upload_file_dropdown.png diff --git a/doc/workflow/web_editor.md b/doc/workflow/web_editor.md index 7fc8f96b9ec..4a451d98953 100644 --- a/doc/workflow/web_editor.md +++ b/doc/workflow/web_editor.md @@ -1,26 +1,120 @@ # GitLab Web Editor -In GitLab you can create new files and edit existing files using our web editor. -This is especially useful if you don't have access to a command line or you just want to do a quick fix. -You can easily access the web editor, depending on the context. -Let's start from newly created project. +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. -Click on `Add a file` -to create the first file and open it in the web editor. +## 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. -Fill in a file name, some content, a commit message, branch name and press the commit button. -The file will be saved to the repository. + - +--- -You can edit any text file in a repository by pressing the edit button, when -viewing the file. +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. -Editing a file is almost the same as creating a new file, -with as addition the ability to preview your changes in a separate tab. Also you can save your change to another branch by filling out field `branch` + - +## 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. + + + +--- + +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. + + + +## 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. + + + +--- + +In the new directory dialog enter a directory name, a commit message and choose +the target branch. Click **Create directory** to finish. + + + +## Create a new branch + +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. + + + +--- + +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. + + + +--- + +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. + + + +## 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. + + + +--- + +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. + + + +## 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. + + diff --git a/doc/workflow/web_editor/edit_file.png b/doc/workflow/web_editor/edit_file.png Binary files differdeleted file mode 100644 index f480c69ac3e..00000000000 --- a/doc/workflow/web_editor/edit_file.png +++ /dev/null diff --git a/doc/workflow/web_editor/empty_project.png b/doc/workflow/web_editor/empty_project.png Binary files differdeleted file mode 100644 index 6a049f6beaf..00000000000 --- a/doc/workflow/web_editor/empty_project.png +++ /dev/null diff --git a/doc/workflow/web_editor/new_file.png b/doc/workflow/web_editor/new_file.png Binary files differdeleted file mode 100644 index 55ebd9e0257..00000000000 --- a/doc/workflow/web_editor/new_file.png +++ /dev/null diff --git a/doc/workflow/web_editor/show_file.png b/doc/workflow/web_editor/show_file.png Binary files differdeleted file mode 100644 index 9cafcb55109..00000000000 --- a/doc/workflow/web_editor/show_file.png +++ /dev/null |
