Edit a read-only project in the Web IDE via forking workflow
Problem to solve
The Web IDE is only available to users with write access to the repository. Forking means it is possible for anyone to contribute to a public project, by making a fork, committing their change and opening a merge request.
We should make it possible to edit read-only projects, then commit them to a new or existing fork.
Intended users
Developers, in both commercial and open source contexts.
Further details
We want the Web IDE to be used for all file/code editing in the GitLab interface, replacing the ACE editor. Support for forking workflows is a requirement so that there is not a loss of functionality.
Support for editing read only projects in the Web IDE will also make it much easier for occasional contributors, or documentation contributors to improve open source projects like GitLab. We will be able to add the Web IDE link to every documentation and handbook page so that anyone can contribute in a single click in a more powerful editor that allows multiple files to be edited.
Proposal
As a person who is signed in to GitLab, I will be able to:
- open any project in the Web IDE that I have read access to
- if the person has write permissions to the project:
- allow them to commit to the project
- otherwise (the person does not have write permissions):
- allow them to commit to a new fork
- allow them to commit to an existing fork
Mockup: create a fork and commit |
---|
Permissions and Security
The proposed behavior is consistent with existing behavior in the single file editor.
Documentation
Documentation for the web ide should be updated to explain that committing to a fork is supported.
What does success look like, and how can we measure that?
By supporting more workflows, we should see continued increase in the use of the Web IDE for editing workflows in GitLab.