Reformat sonar-docs readme using Prettier

diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md
index 5d98d7ecc7ece26822a9a33f59cb836f64973b57..628a1bd022d9cc0b02c6c432e6551fb0f9b0d450 100644 (file)
--- a/server/sonar-docs/README.md
+++ b/server/sonar-docs/README.md
@@ -5,22 +5,22 @@
 The documentation content lives in `sonar-enterprise/server/sonar-docs`  
 We use an augmented GitHub markdown syntax:
 
-* general: https://guides.github.com/features/mastering-markdown/
-* general: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
-* linebreaks: https://gist.github.com/shaunlebron/746476e6e7a4d698b373
+- general: https://guides.github.com/features/mastering-markdown/
+- general: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
+- linebreaks: https://gist.github.com/shaunlebron/746476e6e7a4d698b373
 
 ## The first time
 
-* Install nodejs, v8.11.3 not 10, which is the latest.
-* Install https://yarnpkg.com/en
-* Add to your .bashrc:
-  * `export ARTIFACTORY_PRIVATE_USERNAME=...`
-  * `export ARTIFACTORY_PRIVATE_PASSWORD=...`
-* Open a new shell or execute those exports in your current session  
+- Install nodejs, v8.11.3 not 10, which is the latest.
+- Install https://yarnpkg.com/en
+- Add to your .bashrc:
+  - `export ARTIFACTORY_PRIVATE_USERNAME=...`
+  - `export ARTIFACTORY_PRIVATE_PASSWORD=...`
+- Open a new shell or execute those exports in your current session  
   You can validate this step by executing:
-  * `echo $ARTIFACTORY_PRIVATE_USERNAME`
-  * `echo $ARTIFACTORY_PRIVATE_PASSWORD`
-* Run the following to set up the dev servers:
+  - `echo $ARTIFACTORY_PRIVATE_USERNAME`
+  - `echo $ARTIFACTORY_PRIVATE_PASSWORD`
+- Run the following to set up the dev servers:
 
 ```
 cd sonar-enterprise/server/sonar-web
@@ -63,20 +63,25 @@ yarn develop
 ```
 
 ## Testing
+
 As documentation writers there are two ways it is possible for us to break the SonarQube build
-* malformed markup
-* broken links
+
+- malformed markup
+- broken links
 
 Even without spinning up servers, you can double-check that your changes won't break the build.
 
 **Test everything**  
 You can run all the tests, and make sure that both your markup is well-formed and your links are correct by running the build script:
+
 ```
 cd sonar-enterprise/
 ./build.sh -x test -x obfuscate
 ```
+
 **Test links only**  
 If you only want to double-check your links changes, you can
+
 ```
 cd sonar-enterprise/server/sonar-docs
 yarn jest
@@ -85,26 +90,28 @@ yarn jest
 This will run the broken link test and stop at the first broken link it finds. Continue running this iteratively until it passes.
 
 ## Committing
+
 **Always start your commit message with "DOCS".**
 
 The convention is to start commit messages with the ticket number the changes are for. Since docs changes are often made without tickets, use "DOCS" instead.
 
 ## Navigation trees
-Controlling the navigation trees of the tree instances is covered in [static/README.md](static)
 
+Controlling the navigation trees of the tree instances is covered in [static/README.md](static)
 
 ## Writing docs
 
 ### URLs
+
 All urls _must_ end with a trailing slash (`/`).
 
 ### Header
 
 Each documentation file should contain a header at the top of the file delimited by "---" top and bottom. The header holds file metadata:
 
-* The `title` tag defines the title of the page.
-* The `url` tag is required and defines the path at which to publish the page. Reminder: end this with a trailing slash.
-* The `nav` tag is optional and controls the title of the page inside the navigation tree.
+- The `title` tag defines the title of the page.
+- The `url` tag is required and defines the path at which to publish the page. Reminder: end this with a trailing slash.
+- The `nav` tag is optional and controls the title of the page inside the navigation tree.
 
 Ex.:
 
@@ -117,22 +124,23 @@ url: /sonarcloud-pricing/
 ```
 
 ** Metadata conventions**
-* Metadata tags can appear in any order, but by convention, `title` should come first.
-* The `url` tag is required, and should start and end with '/'
 
+- Metadata tags can appear in any order, but by convention, `title` should come first.
+- The `url` tag is required, and should start and end with '/'
 
 ### Includes
 
 Basic syntax: `@include tooltips/quality-gates/quality-gate`
 
-* path omits trailing '.md'
-* path starts from 'src', regardless of where the including page is.
+- path omits trailing '.md'
+- path starts from 'src', regardless of where the including page is.
 
 ### Conditional Content
 
 With special comments you can mark a page or a part of the content to be displayed only on SonarCloud, SonarQube or the static documentation website.
 
 To drop in "SonarQube" or "SonarCloud" as appropriate, use:
+
 ```
 {instance}
 ```
@@ -174,21 +182,20 @@ The resulting table of contents will also list all h1 items, but h1 is used for
 
 #### Links
 
-* External page (automatically opens in a new tab): `[Link text](https://www.sonarsource.com/)`
-* Another documentation page: `[Link text](/short-lived-branches/)`
-  * path omits trailing '.md'
-  * links inside tooltips always open in a new tab
-* Internal SonarCloud app page: `[Link text](/#sonarcloud#/onboarding)`
-
-  * it is possible to reference app pages only inside SonarCloud documentation page (`scope: sonarcloud`), because these links are not valid on the static documentation
+- External page (automatically opens in a new tab): `[Link text](https://www.sonarsource.com/)`
+- Another documentation page: `[Link text](/short-lived-branches/)`
+  - path omits trailing '.md'
+  - links inside tooltips always open in a new tab
+- Internal SonarCloud app page: `[Link text](/#sonarcloud#/onboarding)`
+  - it is possible to reference app pages only inside SonarCloud documentation page (`scope: sonarcloud`), because these links are not valid on the static documentation
 
 #### Smart Links
 
 Use this syntax to conditionally link from the embedded docs to pages within the SonarQube application. Specifically, in the static website links will be suppressed, but the link text will be shown. In the embedded documentation, administrative links will only be linked for administrative users.
 
-* Internal SonarQube app page: `[Link text](/#sonarqube#/...)`
-  * On SonarCloud, only the link text will be displayed, not wrapped into a link tag
-* Internal SonarQube app page: `[Link text](/#sonarqube-admin#/...)`
+- Internal SonarQube app page: `[Link text](/#sonarqube#/...)`
+  - On SonarCloud, only the link text will be displayed, not wrapped into a link tag
+- Internal SonarQube app page: `[Link text](/#sonarqube-admin#/...)`
 
 #### Linebreaks
 
@@ -238,15 +245,15 @@ The first line of the block must be a title. You can have as many lines as you w
 
 Basic syntax: `![alt text.](/images/short-lived-branch-concept.png)`
 
-* images are auto-sized to 100% if they're larger than 100%
-* paths start from 'src', regardless of where the calling page is
+- images are auto-sized to 100% if they're larger than 100%
+- paths start from 'src', regardless of where the calling page is
 
 #### Icons
 
-* :warning: `![](/images/exclamation.svg)`
-* :information_source: `![](/images/info.svg)`
-* :heavy_check_mark: `![](/images/check.svg)`
-* :x: `![](/images/cross.svg)`
+- :warning: `![](/images/exclamation.svg)`
+- :information_source: `![](/images/info.svg)`
+- :heavy_check_mark: `![](/images/check.svg)`
+- :x: `![](/images/cross.svg)`
 
 #### Message box
 
@@ -261,10 +268,10 @@ Basic syntax:
 
 There are four options:
 
-* danger (red)
-* warning (yellow)
-* success (green)
-* info (blue)
+- danger (red)
+- warning (yellow)
+- success (green)
+- info (blue)
 
 You can also put icons inside messages: