From 8d88dee0dd0a886a454f1874166991f8c993b873 Mon Sep 17 00:00:00 2001 From: CS Date: Wed, 9 Sep 2020 16:24:37 +0200 Subject: [PATCH] DOCS minor updates for AzDO, DCE and Apache mod_proxy (#3130) * Fine-tune wording * sonar.cluster.node.host must not be a loopback address * Escape backslash in mod_proxy * Add info on renaming default branch --- .../pages/analysis/scan/sonarscanner-for-azure-devops.md | 3 +++ server/sonar-docs/src/pages/setup/install-cluster.md | 2 +- server/sonar-docs/src/pages/setup/operate-cluster.md | 2 +- server/sonar-docs/src/pages/setup/operate-server.md | 6 +++--- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md index 058935cedac..5adefd3fb75 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md @@ -154,6 +154,9 @@ _Branch and Pull Request analysis are available starting in [Developer Edition]( ### Branches When a build is run on a branch of your project, the extension automatically configures the analysis to be pushed to the relevant project branch in {instance}. The same build definition can apply to all your branches, whatever type of Git repository you are analyzing, +[[info]] +| If the branch to be analyzed is the **default** branch of your repository, it will be analyzed as the **master** or **main** branch of your SonarQube project. You can [rename](/branches/overview/) it in SonarQube after the first analysis. + If you are working with branches on TFVC projects, you still need to manually specify the branch to be used on {instance}: in the **Prepare Analysis Configuration** task, in the **Additional Properties**, you need to set `sonar.branch.name`. ### Pull Requests diff --git a/server/sonar-docs/src/pages/setup/install-cluster.md b/server/sonar-docs/src/pages/setup/install-cluster.md index fdb75c46395..23c734a33c1 100644 --- a/server/sonar-docs/src/pages/setup/install-cluster.md +++ b/server/sonar-docs/src/pages/setup/install-cluster.md @@ -172,4 +172,4 @@ The following is an example of the default SonarQube cluster installation proces 4. After all search nodes are running, start all application nodes. 5. Configure the load balancer to proxy with both application nodes. -Congratulations, you have a fully-functional SonarQube cluster. Once these steps are complete, take a break and a coffee, then you can [Operate your Cluster](/setup/operate-cluster/). \ No newline at end of file +Congratulations, you have a fully-functional SonarQube cluster. Once you've complete these steps, you can [Operate your Cluster](/setup/operate-cluster/). diff --git a/server/sonar-docs/src/pages/setup/operate-cluster.md b/server/sonar-docs/src/pages/setup/operate-cluster.md index 231290823c1..b4bba3e5231 100644 --- a/server/sonar-docs/src/pages/setup/operate-cluster.md +++ b/server/sonar-docs/src/pages/setup/operate-cluster.md @@ -104,7 +104,7 @@ Property | Description | Default | Required | `sonar.cluster.search.hosts`|Comma-delimited list of search hosts in the cluster. Each item in the list must contain the port if the default `sonar.search.port` value is not used. Item format is `sonar.search.host` or `sonar.search.host:sonar.search.port`.| |yes `sonar.cluster.node.name`|The name of the node that is used on Elasticsearch and stored in Hazelcast member attribute (NODE_NAME) for sonar-application|`sonarqube-{UUID}`|no `sonar.cluster.node.type`|Type of node: either `application` or `search`| |yes -`sonar.cluster.node.host`|IP address of the network card that will be used by Hazelcast to communicate with the members of the cluster| |yes +`sonar.cluster.node.host`|IP address of the network card that will be used by Hazelcast to communicate with the members of the cluster. Must not be a loopback address.| |yes ### Application nodes diff --git a/server/sonar-docs/src/pages/setup/operate-server.md b/server/sonar-docs/src/pages/setup/operate-server.md index f6c49db0443..4db8cf8718d 100644 --- a/server/sonar-docs/src/pages/setup/operate-server.md +++ b/server/sonar-docs/src/pages/setup/operate-server.md @@ -125,7 +125,7 @@ This section helps you configure the SonarQube Server if you want to run it behi ### Using an Apache Proxy -We assume that you've already installed Apache 2 with module mod_proxy, that SonarQube is running and available on `http://private_sonar_host:sonar_port/` and that you want to configure a Virtual Host for `www.public_sonar.com`. +We assume that you've already installed Apache 2 with module mod\_proxy, that SonarQube is running and available on `http://private_sonar_host:sonar_port/`, and that you want to configure a Virtual Host for `www.public_sonar.com`. At this point, edit the HTTPd configuration file for the `www.public_sonar.com` virtual host. Include the following to expose SonarQube via `mod_proxy` at `http://www.public_sonar.com/`: @@ -142,7 +142,7 @@ ProxyPreserveHost On ``` -Apache configuration is going to vary based on your own application's requirements and the way you intend to expose SonarQube to the outside world. If you need more details about Apache HTTPd and mod_proxy, please see [http://httpd.apache.org](http://httpd.apache.org). +Apache configuration is going to vary based on your own application's requirements and the way you intend to expose SonarQube to the outside world. If you need more details about Apache HTTPd and mod\_proxy, please see [http://httpd.apache.org](http://httpd.apache.org). ### Using Nginx @@ -193,4 +193,4 @@ server { proxy_set_header X-Forwarded-Proto https; } } -``` \ No newline at end of file +``` -- 2.39.5