diff --git a/external/contribute/web-ide/img/img1.png b/external/contribute/web-ide/img/img1.png new file mode 100644 index 0000000000000000000000000000000000000000..da8b0be918e881a61f52c59177a851589540dc9b --- /dev/null +++ b/external/contribute/web-ide/img/img1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:09260cc9a972ff16bf25f78eadfb0ccdfe6a567733db592b1719bad43ab66fed +size 23685 diff --git a/external/contribute/web-ide/img/img10.png b/external/contribute/web-ide/img/img10.png new file mode 100644 index 0000000000000000000000000000000000000000..cfbc988322ac8085467294350c6606de4111d84b --- /dev/null +++ b/external/contribute/web-ide/img/img10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47970aff6140cde1ceb3dd70584b49fb07893c7c80f8eecfeb0df8a29b8b8c8f +size 8047 diff --git a/external/contribute/web-ide/img/img11.png b/external/contribute/web-ide/img/img11.png new file mode 100644 index 0000000000000000000000000000000000000000..8033f603acbfd863f94a9af1cf9dbb2f21bb29de --- /dev/null +++ b/external/contribute/web-ide/img/img11.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2a854de2b20fbbf335ced4a93512c3e8ea110f6a0e3c3b8580cf8d16bfc1344a +size 155962 diff --git a/external/contribute/web-ide/img/img2.png b/external/contribute/web-ide/img/img2.png new file mode 100644 index 0000000000000000000000000000000000000000..faf65b8257cfdd2c0629200a46deb840aae0e898 --- /dev/null +++ b/external/contribute/web-ide/img/img2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:095ff4f2293c1ff66a8c5ea8ad3d3b5d2d5e434c406673af15c6ce3611724df9 +size 5232 diff --git a/external/contribute/web-ide/img/img3.png b/external/contribute/web-ide/img/img3.png new file mode 100644 index 0000000000000000000000000000000000000000..740852a29d931dbde9e0a534eb3bf654454a8646 --- /dev/null +++ b/external/contribute/web-ide/img/img3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:23a37b1b48f895c4f08e26e814fc9e19209668504c0793db2821f96624c39d72 +size 4926 diff --git a/external/contribute/web-ide/img/img4.png b/external/contribute/web-ide/img/img4.png new file mode 100644 index 0000000000000000000000000000000000000000..c2b71c42e5fc84557fc5e114a967145f0e2130fa --- /dev/null +++ b/external/contribute/web-ide/img/img4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45120dbc61647f98db594bb4556b2c675060d765864db3f3f5ec82ee82669f83 +size 472499 diff --git a/external/contribute/web-ide/img/img5.png b/external/contribute/web-ide/img/img5.png new file mode 100644 index 0000000000000000000000000000000000000000..4f8e25cd6c7296a2ecfb8b1468fcc7b69d0c7b3c --- /dev/null +++ b/external/contribute/web-ide/img/img5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ffdd3b6ab4fc89d3a67fa6351d2b51377480f07c9048b9213c4b112c54251732 +size 32194 diff --git a/external/contribute/web-ide/img/img6.png b/external/contribute/web-ide/img/img6.png new file mode 100644 index 0000000000000000000000000000000000000000..ae0a4f1c78e40a2fc009aa92d18811c6a464c08f --- /dev/null +++ b/external/contribute/web-ide/img/img6.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:e5a9f6a7eab97ebb4c4d38c18dc5c43fed27d65d80cf7fa3fc19c684c33a8eab +size 7329 diff --git a/external/contribute/web-ide/img/img7.png b/external/contribute/web-ide/img/img7.png new file mode 100644 index 0000000000000000000000000000000000000000..8ea83d4c797159cd44b2541042274330a7a4c903 --- /dev/null +++ b/external/contribute/web-ide/img/img7.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cc000e8d6393c236f212503d90ee4c1c12467c27aedaa72c7ef468aac86d96b3 +size 365943 diff --git a/external/contribute/web-ide/img/img8.png b/external/contribute/web-ide/img/img8.png new file mode 100644 index 0000000000000000000000000000000000000000..c9db8e71ef0ffa8da165f80eac2fe78ad6c50f53 --- /dev/null +++ b/external/contribute/web-ide/img/img8.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0d00d4bd3fd71c7cc9c110d65f2d5ccdbd7706a16918bb6642e27875f1d8f414 +size 25899 diff --git a/external/contribute/web-ide/img/img9.png b/external/contribute/web-ide/img/img9.png new file mode 100644 index 0000000000000000000000000000000000000000..7b19bbfdbe7b32a68812789acce6461ddc3f5c82 --- /dev/null +++ b/external/contribute/web-ide/img/img9.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a04223fd574032c5423cbcea63182b0535d6756399fa5eaaede1a2ca90f08f1c +size 205695 diff --git a/external/contribute/web-ide/web-ide.md b/external/contribute/web-ide/web-ide.md index bdcac0b86e330d029368f0a3c5bece9c77c1cc58..8367252925a10a4a81a68f8e23cfb1a512a26c91 100644 --- a/external/contribute/web-ide/web-ide.md +++ b/external/contribute/web-ide/web-ide.md @@ -9,3 +9,75 @@ redirect_from: # Contribute using Gitlab Web IDE This shows how to use Gitlab Web IDE to add or edit a howto-card: + +Before you start, please make sure that you have the correct access rights to edit the repository. + +*Note: If you do not have the rights to edit the repository, you can either ask for permissions by contacting the repository maintainers, or use your own copy of the repository (called a `fork`). Please follow [these instructions]](create-fork) to obtain your copy (fork). You can then [mirror the fork automatically](/cards/contribute:mirror-fork) to keep in sync.* + +A clear difference between editing a file in a git-tracked repository compared to a live document is that you can make an edit directly, and then suggesting the change. You can make this edit on your own version (called a `branch`), and then request to merge your changes into the main repository (through opening a `merge request`). + +## Select the development version (branch) + +Before making an edit, please follow the instructions in the `README.md` file. Often, a standard development scheme is followed. For instance, there is a `master` branch (usually referred to as the stable version of the repository) and a `develop` branch (the unstable development version of the repository). There can also be lots of other versions in the same repository. In order to select the development version (`develop` branch), click on the drop-down menu and select `develop` + +<img src="img/img1.png"> + +The page will refresh and show the repository contents. On the top left of the page, you can see that the `develop` branch has been selected. + +<img src="img/img2.png"> + +## Open the web editor (Web IDE) + +You can now open the web editor (integrated development environment or IDE) by clicking on the Web IDE button: + +<img src="img/img3.png"> + +Now, you can make changes to the file you wish. As an example, we will make a change to the file `privacy_policy.md`. Select the file `privacy_policy.md` from the list on the left. + +<img src="img/img4.png"> + +Now, edit the file the way you want. For instance. we add a line with `test` in the first section: + +<img src="img/img5.png"> + +*Note: You can see a green line on the left side of it, indicating that a new line has been added. The vertical line turns blue if a line is edited.* + +## Committing your change + +As already mentioned, a change has to be proposed, and will then be reviewed. The system used is through `merge requests`. Now, as you have edited the file, you can see that on the bottom left of the window, a blue button appeared: + +<img src="img/img6.png"> + +*Note: There is no `Save` button. You save your work by committing changes.* + +When clicking on submit, the page changes to display the changes made: + +<img src="img/img7.png"> + +You can see that a green line has been added on the right column. The left column displays the original file (of the `develop` branch). + +On the bottom left, you can see a form for committin the change. Here, you have to select `Create a new branch`. This is **important**. + +<img src="img/img8.png"> + +You can also add a specific commit message to label the change properly. The name of the branch is generated automatically. You can, if you want, change it as well. + +Then, select `Start a new request` when you are ready to start the submission process and hit the `Commit` button. + +## Submitting your merge request + +After hitting the `Commit` button, you will be redirect to the submission page for your merge request: + +<img src="img/img9.png"> + +Please make sure that you see that you are proposing to merge your branch (version) into the `develop` branch. This is shown at the top of the page: + +<img src="img/img10.png"> + +You can then fill our the merge request submission form. and select, for instance, an `Assignee`. + +Good practice is to select `Delete source branch when merge request is accepted.` + +Under `Changes`, you can see the added line: + +<img src="img/img11.png"> \ No newline at end of file