... | @@ -113,32 +113,47 @@ The CII all-in-one User Manual is composed of a dozen sub-documents in reStructu |
... | @@ -113,32 +113,47 @@ The CII all-in-one User Manual is composed of a dozen sub-documents in reStructu |
|
|
|
|
|
The documentation resides in `https://gitlab.eso.org/cii/info/cii-docs.git` that you can clone as usual to local workspace, then modify and create a merge request.
|
|
The documentation resides in `https://gitlab.eso.org/cii/info/cii-docs.git` that you can clone as usual to local workspace, then modify and create a merge request.
|
|
|
|
|
|
Alternatively, and recommended, you can edit the files directly in the browser by using the Web IDE built into gitlab:
|
|
Alternatively, and recommended, you can edit the files directly in the browser by using the File Editor built into gitlab:
|
|
|
|
|
|
_Note: If any of the buttons mentioned below is greyed out, you're lacking permissions. If so, please contact us first to request permission._
|
|
_Note: If any of the buttons mentioned below is greyed out, you're lacking permissions. If so, please contact us first to request permission._
|
|
|
|
|
|
1. Browse to <https://gitlab.eso.org/cii/info/cii-docs>
|
|
1. Browse to <https://gitlab.eso.org/cii/info/cii-docs>,
|
|
2. Press "Web IDE"
|
|
and navigate to folder `userManual/ciiman/src/docs`
|
|
3. In the Web IDE's file tree (left),
|
|
2. Find the correct .rst file, select it, and press "Edit",
|
|
|
|
and from the pop-up list of choices, prefer the "Edit single file"
|
|
* navigate to `userManual/ciiman/src/docs`
|
|
3. Make your changes in the content editing page.
|
|
* find and select the .rst file, and make your changes
|
|
Note you can toggle between Write and Preview mode.
|
|
|
|
|
|
4. Commit (blue button on lower left),
|
|
When done with editing, see the lower part of the screen:
|
|
|
|
|
|
* Leave the defaults (Create a new branch: YES, Start a new merge request: YES)
|
|
4. Describe your change:
|
|
* Write commit message: please write some rationale for your contribution
|
|
* Commit message: please write some rationale for your contribution
|
|
|
|
Info: this text will re-appear later as the Title of your Merge Request.
|
|
5. Commit again (green button on lower left)
|
|
* Target branch:
|
|
|
|
* DO NOT use the default (master), instead:
|
|
* Leave the defaults (Delete source branch on commit: YES)
|
|
* empty the field and write e.g.
|
|
|
|
"hints-on-creating-document", or
|
|
6. Create Merge Request (blue button)
|
|
"more-details-on-network-interface"
|
|
|
|
Note there cannot be whitespace in this name
|
|
* wait for pipeline to finish, at which point Jenkins will add his comment,
|
|
* Checkbox "Start a new merge request": leave default (YES)
|
|
* and in that comment follow the link under "Artifacts List" to see your change applied.
|
|
5. Commit changes (blue button on lower left),
|
|
|
|
|
|
7. To refine the applied change, go back to step 2.
|
|
The Merge Request window appears:
|
|
|
|
|
|
|
|
6. It is all prefilled. If you want you can make changes:
|
|
|
|
* The Title. It is prefilled from your commit message, but you can change it
|
|
|
|
* Leave all the defaults (Mark as draft: NO, Delete source branch: YES, Squash: NO)
|
|
|
|
7. Create Merge Request (blue button)
|
|
|
|
|
|
|
|
Inspect the result:
|
|
|
|
|
|
|
|
8. wait for pipeline to finish
|
|
|
|
* After the pipeline finishes, Jenkins will add its comment to your merge request page.
|
|
|
|
* and in that comment follow the link under "Artifacts List" to see your change applied.
|
|
|
|
|
|
|
|
8. To refine the applied change, go back to step 1.
|
|
|
|
Use the same branch name in step 4, so that you do not create a 2nd Merge Request
|
|
|
|
(what you want is to update your Merge Request, not create another one).
|
|
|
|
|
|
We'll check the merge request, and your change can make it to the next release. Thanks in advance!
|
|
We'll check the merge request, and your change can make it to the next release. Thanks in advance!
|
|
|
|
|
... | | ... | |