From b21a58e0fc2629ca5da23bd8eaa9af69e0ae4c18 Mon Sep 17 00:00:00 2001 From: ramonsalguer <javier.ramon@telefonica.com> Date: Mon, 11 Mar 2019 19:26:18 +0100 Subject: [PATCH] - Format added to list of VSCode extensions - Typos fixed in steps 3 and 4 of editor's guide --- ...low for documentation production in OSM.md | 51 ++++++++++--------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/Workflow for documentation production in OSM.md b/Workflow for documentation production in OSM.md index d4b8689..31342bb 100644 --- a/Workflow for documentation production in OSM.md +++ b/Workflow for documentation production in OSM.md @@ -25,33 +25,34 @@ Basic Software: - OpenSSH - Markdown editor(s). Recommended (both): - Integrated: Visual Studio Code + - The integrated editor would support version control operations graphically, so that usual operations do not require a command line. - WYSIWYG: Typora ### Some recommended extensions for Visual Studio Code -- bat67.markdown-extension-pack -- yzhang.markdown-all-in-one -- DavidAnson.vscode-markdownlint -- satokaz.vscode-markdown-header-coloring -- wayou.vscode-todo-highlight -- streetsidesoftware.code-spell-checker -- bierner.github-markdown-preview -- shd101wyy.markdown-preview-enhanced -- geeklearningio.graphviz-markdown-preview -- eamodio.gitlens -- donjayamanne.githistory -- bierner.markdown-checkbox -- bierner.markdown-emoji -- bierner.markdown-mermaid -- bierner.markdown-preview-github-styles -- bierner.markdown-yaml-preamble -- mrmlnc.vscode-remark -- csholmq.excel-to-markdown-table -- DougFinke.vscode-pandoc -- fcrespo82.markdown-table-formatter -- yzane.markdown-pdf - -To install extensions in VSCode you can follow the procedures described in: https://code.visualstudio.com/docs/editor/extension-gallery +- `bat67.markdown-extension-pack` +- `yzhang.markdown-all-in-one` +- `DavidAnson.vscode-markdownlint` +- `satokaz.vscode-markdown-header-coloring` +- `wayou.vscode-todo-highlight` +- `streetsidesoftware.code-spell-checker` +- `bierner.github-markdown-preview` +- `shd101wyy.markdown-preview-enhanced` +- `geeklearningio.graphviz-markdown-preview` +- `eamodio.gitlens` +- `donjayamanne.githistory` +- `bierner.markdown-checkbox` +- `bierner.markdown-emoji` +- `bierner.markdown-mermaid` +- `bierner.markdown-preview-github-styles` +- `bierner.markdown-yaml-preamble` +- `mrmlnc.vscode-remark` +- `csholmq.excel-to-markdown-table` +- `DougFinke.vscode-pandoc` +- `fcrespo82.markdown-table-formatter` +- `yzane.markdown-pdf` + +To install extensions in VSCode you can follow any of the procedures described in: https://code.visualstudio.com/docs/editor/extension-gallery ## Markdown conversion basics @@ -147,7 +148,7 @@ When your are ready, you can push your branch to the remote repo: 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). +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, in the _Merge Requests_ area (on the left side bar). Your recently pushed branch would be there to be selected for your new merge request. ### Step 4: Result of the review @@ -157,7 +158,7 @@ If your contribution was **commented** by the editor, you should try to address 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: -``` +```bash git checkout master git pull origin master ``` -- GitLab