diff --git a/Workflow for documentation production in OSM.md b/Workflow for documentation production in OSM.md index d634777e4f214192b2c4132f524c4f1cf7c4467a..d4b8689674200c71a82f79758da680f3f12baf0e 100644 --- a/Workflow for documentation production in OSM.md +++ b/Workflow for documentation production in OSM.md @@ -149,36 +149,25 @@ git push origin BranchNewSection Once you have pushed your branch to the remote repo, you should **inform the editor of it by making a _merge request_**. This can be easily made in the [GitLab web](https://osm.etsi.org/gitlab/osm_doc/test/merge_requests) (your recently pushed branch would be there). -### Step 4: Wait for the result of the review +### Step 4: Result of the review -The merge request might have different potential results: +Following your _merge request_, the editor will revise the changes suggested in your branch and decide whether they should be merged or receive comments from the editor. -#### Your contribution was commented by the editor +If your contribution was **commented** by the editor, you should try to address the comments in your branch and push them again if appropriate (in case the contribution has not been entirely rejected by the editor). - - -### Your contribution has been integrated (merged) by the editor - -The result would be available in the main edition branch (`master`). - -You should update your local repository before attempting further edits: +If your contribution was integrated (**merged**) by the editor, the result will be available in the main edition branch (i.e. `master`) as a new commit . Therefore, you should update your local repository (`pull`) before attempting further edits: ``` git checkout master -git pull +git pull origin master ``` - -### Step 5: (Once merged) update your local master - ## TODO: Guide for editors ### Step 0: Setup of the repository and initial contribution #### If you start from an empty local folder and the repo in ETSI's Gitlab is still empty **(RECOMMENDED)** - - #### If you have the content in a local folder and the repo in ETSI's Gitlab is still empty (initial load of info) If it was not under Git control yet, initialize it: