aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs/README.md
diff options
context:
space:
mode:
authorG. Ann Campbell <ann.campbell@sonarsource.com>2018-10-10 15:38:53 +0200
committerSonarTech <sonartech@sonarsource.com>2018-10-10 20:20:56 +0200
commit2fac84bbe12515bb7d446a7cdc6be86fd3377b86 (patch)
tree3669638c0af0b95904309b0c17ebec8b5e2a9e43 /server/sonar-docs/README.md
parent75ff5a8ed492a1d980b17ad7cc2b87ee2439649c (diff)
downloadsonarqube-2fac84bbe12515bb7d446a7cdc6be86fd3377b86.tar.gz
sonarqube-2fac84bbe12515bb7d446a7cdc6be86fd3377b86.zip
Port remaining SONAR space docs
Diffstat (limited to 'server/sonar-docs/README.md')
-rw-r--r--server/sonar-docs/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md
index aca7bd3b15d..ec1c9164310 100644
--- a/server/sonar-docs/README.md
+++ b/server/sonar-docs/README.md
@@ -68,13 +68,14 @@ As documentation writers there are two ways it is possible for us to break the S
* broken links
Even without spinning up servers, you can double-check that your changes won't break the build.
-**Test everything**
+
+**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**
+**Test links only**
If you only want to double-check your links changes, you can
```
cd sonar-enterprise/server/sonar-docs
@@ -104,13 +105,13 @@ Ex.:
```
---
title: Demo page
-url: /sonarcloud-pricing
+url: /sonarcloud-pricing/
---
```
** Metadata conventions**
* Metadata tags can appear in any order, but by convention, `title` should come first.
-* The `url` tag is optional, but by convention, should be specified to both make the publish path explicit and avoid problems potentially caused by moving or renaming files.
+* The `url` tag is required, and should start and end with '/'
### Includes
@@ -221,7 +222,8 @@ baz
Basic syntax:
-```[[collapse]]
+```
+[[collapse]]
| ## Block title
| Block content
```