Skip to content
Snippets Groups Projects
Commit b21a58e0 authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

- Format added to list of VSCode extensions

- Typos fixed in steps 3 and 4 of editor's guide
parent c7c38bfe
No related branches found
No related tags found
No related merge requests found
...@@ -25,33 +25,34 @@ Basic Software: ...@@ -25,33 +25,34 @@ Basic Software:
- OpenSSH - OpenSSH
- Markdown editor(s). Recommended (both): - Markdown editor(s). Recommended (both):
- Integrated: Visual Studio Code - 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 - WYSIWYG: Typora
### Some recommended extensions for Visual Studio Code ### Some recommended extensions for Visual Studio Code
- bat67.markdown-extension-pack - `bat67.markdown-extension-pack`
- yzhang.markdown-all-in-one - `yzhang.markdown-all-in-one`
- DavidAnson.vscode-markdownlint - `DavidAnson.vscode-markdownlint`
- satokaz.vscode-markdown-header-coloring - `satokaz.vscode-markdown-header-coloring`
- wayou.vscode-todo-highlight - `wayou.vscode-todo-highlight`
- streetsidesoftware.code-spell-checker - `streetsidesoftware.code-spell-checker`
- bierner.github-markdown-preview - `bierner.github-markdown-preview`
- shd101wyy.markdown-preview-enhanced - `shd101wyy.markdown-preview-enhanced`
- geeklearningio.graphviz-markdown-preview - `geeklearningio.graphviz-markdown-preview`
- eamodio.gitlens - `eamodio.gitlens`
- donjayamanne.githistory - `donjayamanne.githistory`
- bierner.markdown-checkbox - `bierner.markdown-checkbox`
- bierner.markdown-emoji - `bierner.markdown-emoji`
- bierner.markdown-mermaid - `bierner.markdown-mermaid`
- bierner.markdown-preview-github-styles - `bierner.markdown-preview-github-styles`
- bierner.markdown-yaml-preamble - `bierner.markdown-yaml-preamble`
- mrmlnc.vscode-remark - `mrmlnc.vscode-remark`
- csholmq.excel-to-markdown-table - `csholmq.excel-to-markdown-table`
- DougFinke.vscode-pandoc - `DougFinke.vscode-pandoc`
- fcrespo82.markdown-table-formatter - `fcrespo82.markdown-table-formatter`
- yzane.markdown-pdf - `yzane.markdown-pdf`
To install extensions in VSCode you can follow the procedures described in: https://code.visualstudio.com/docs/editor/extension-gallery 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 ## Markdown conversion basics
...@@ -147,7 +148,7 @@ When your are ready, you can push your branch to the remote repo: ...@@ -147,7 +148,7 @@ When your are ready, you can push your branch to the remote repo:
git push origin BranchNewSection 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 ### Step 4: Result of the review
...@@ -157,7 +158,7 @@ If your contribution was **commented** by the editor, you should try to address ...@@ -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: 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 checkout master
git pull origin master git pull origin master
``` ```
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment