aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs/README.md
diff options
context:
space:
mode:
authorG. Ann Campbell <ann.campbell@sonarsource.com>2018-09-27 11:01:47 -0400
committersonartech <sonartech@sonarsource.com>2018-10-03 09:28:21 +0200
commitd8bee945bc625291b60a411a37339450fa01a15a (patch)
tree92c7a55ee6a117c05f1d72a813a38cc53f2f13ff /server/sonar-docs/README.md
parent4e20e6a9ff7014608708040b3e082011da6a3631 (diff)
downloadsonarqube-d8bee945bc625291b60a411a37339450fa01a15a.tar.gz
sonarqube-d8bee945bc625291b60a411a37339450fa01a15a.zip
Revert "MMF-1458 Port SONAR-space docs to embedded docs" (#766)
This reverts commit a7893ef0a269df9bcd39e929e7851aeb6a1b8ed8.
Diffstat (limited to 'server/sonar-docs/README.md')
-rw-r--r--server/sonar-docs/README.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md
index ec1c9164310..aca7bd3b15d 100644
--- a/server/sonar-docs/README.md
+++ b/server/sonar-docs/README.md
@@ -68,14 +68,13 @@ 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
@@ -105,13 +104,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 required, and should start and end with '/'
+* 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.
### Includes
@@ -222,8 +221,7 @@ baz
Basic syntax:
-```
-[[collapse]]
+```[[collapse]]
| ## Block title
| Block content
```