Skip to content

Multi-file editor

demoscript: link

Description

Editing more than a single file using the GitLab interface can feel laborious because each file must be edited one by one, requiring at least one commit for each edited file. This makes contributing larger changes multiple files, be they markdown or source code, through the GitLab interface difficult.

We want to make it easy for everyone to collaborate. Removing barriers will help people contribute more than fixes to typos and dead links, but allow people to contribute larger changes, offer more comprehensive code review suggestions and more.

Kudos to @jschatz1 for idea and proof of concept 👍 (#31890 (closed))

Proof of concept can be accessed by creating a cookie with the key new_repo with the value true.

Proposal

Beta %10.3

The beta should be available as an alternative for the existing blob editor. It should be focussed on editing multiple text files with a single commit.

  • Multi-file editor should allow multiple text files to opened, created, edited and committed as a single commit
  • Multi-file editor should co-exist with existing blob viewer and editor, so that users of current interface are not impacted by limitations or performance problems with the new multi-file editor
  • Multi-file editor should allow the user to view images
  • Multi-file editor should allow the user to see a list of the changed files staged for commit and add a commit message. The user should also be able to identify which lines have changed in those files
  • Multi-file editor should allow the user to adjust the width of panels to suit the information within each panel and make the best use of their screen size
  • Multi-file editor should attempt to prevent users losing their work by navigating to a new page or closing the browser
    • Show warning trying to close page without committing changes
    • Nice to have: Save changes to local storage #40045 (moved)
  • Multi-file editor should be consistent with GitLab visual language

Improvements %10.4

Backlog

GA requirements

Source: https://gitlab.com/gitlab-org/gitlab-ce/issues/31890

Links / references

Documentation blurb

Overview

There are users of GitLab who contributor exclusively through the web interface or occasionally through the web interface to commit changes to documentation, static sites, and even source code.

This feature will improve the experience of those existing users by making contributions to more than one file easier.

Use cases

When web-only GitLab users want to make related edits to multiple files, they are obstructed by having to complete multiple manual steps that are separated by many screens.

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.

Alpha plan #### 1. Alpha %10.2

Building on the proof of concept, the alpha should demonstrate a working editor with no obvious performance regressions. It should work well browsing repositories and be suitable for editing the handbook and other projects commonly edited in the web interface.

Features

Performance

Bugs

Tech debt

Initial designs

Repository - Initial view of files

Initial View upon entering the repository tab. Double-click a file name to open it.

main-view

Repo File Editor - Read-Only View

Once the file is opened, the view of that file appears to slide in from the right. The files view remains and other files can be opened from this menu. Once all files opened are closed, we return to the initial view of the files. The last file closed appears to slide off to the right.

Notes:

Global area above editor:

  • The branch can be changed using the branch dropdown.
  • Users toggle into ‘Edit’ mode by pressing the Edit Mode button.
  • Users can download all files (same functionality as exists now).

File tree editor:

  • This design shows the ability to download all files within the tree editor. This is a duplicate of the download capability in the global bar. Was left in for possible future iterations.
  • Ability to create a new folder or file using the icons.
  • Ability to lock or unlock files. Shown only on subset of folders - when implemented all folders would be unlocked by default, shown via the light gray lock symbol.

Commit Section:

  • There is no commit section visible when the file is in read-only mode.

initial-multi-file-view

Repo File Editor - Edit View

Clicking the Edit Mode button enables the editing of files.

edit-mode--edited-file

Notes:

Target Branch

  • The 'Edit Mode` button text changes to say, 'Cancel Editing'.
  • The branch dropdown becomes locked and a new dropdown appears next to it. This new dropdown selects the target branch for the edits. It is set to create a new branch by default. Users can click the drop-down arrow to change the new branch name or search for and select an existing branch.
  • If you don’t have permission (or the branch is protected) then you cannot edit the files.

TODO: Needs Mockup

Cancel Edit

Users can cancel their edits by selecting the 'Cancel Editing' button.

A confirmation modal is triggered. This modal should match the design from issue#28849

TODO: Needs Mockup

Edit

When a file has been edited, the x becomes a green circle to let users know there are edits that need to be committed.

Screen_Shot_2017-10-03_at_1.52.24_PM

Repo File Editor - Committing changes

When a file (or files) have been edited, the file appears as staged in the commit section.

Screen_Shot_2017-10-03_at_1.52.55_PM

Notes:

*When you make a change on master (with permissions), you will be encouraged to create a merge request. We should not stop people from making changes directly to master if they wish.

*The target branch appears but cannot be changed here.

Edited by Dimitrie Hoekstra