aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs/README.md
diff options
context:
space:
mode:
authorG. Ann Campbell <ann.campbell@sonarsource.com>2018-07-27 12:02:01 -0400
committerSonarTech <sonartech@sonarsource.com>2018-07-27 20:21:19 +0200
commit3ac22018a75b015ebdc7f79fa59e93059ed29512 (patch)
tree9a16342976950bca8fb37b3ac277491664b2343f /server/sonar-docs/README.md
parentbed7a2edba2abce048e3419a97c654c40e863efc (diff)
downloadsonarqube-3ac22018a75b015ebdc7f79fa59e93059ed29512.tar.gz
sonarqube-3ac22018a75b015ebdc7f79fa59e93059ed29512.zip
expand/clarify smart links
Diffstat (limited to 'server/sonar-docs/README.md')
-rw-r--r--server/sonar-docs/README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md
index 54819f5e8e8..3587431fdfd 100644
--- a/server/sonar-docs/README.md
+++ b/server/sonar-docs/README.md
@@ -122,7 +122,7 @@ The resulting table of contents will also list all h1 items, but h1 is used for
* 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 to pages within SonarQube. Specifically, in the generated 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.
+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#/...)`