From 31013914e9b61d4d40ec71cbaaf7f852465a6aec Mon Sep 17 00:00:00 2001 From: Joe Tingsanchali Date: Thu, 2 Sep 2021 16:26:10 -0500 Subject: [PATCH] DOCS update sonar-docs readme docs, update old confluence links without needing redirect to new docs --- server/sonar-docs/README.md | 10 +++++----- server/sonar-docs/src/pages/extend/adding-scm.md | 2 +- .../src/pages/instance-administration/security.md | 2 +- server/sonar-docs/src/pages/setup/install-cluster.md | 2 +- server/sonar-docs/src/pages/setup/overview.md | 4 ++-- server/sonar-docs/src/pages/setup/upgrading.md | 8 ++++---- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/server/sonar-docs/README.md b/server/sonar-docs/README.md index 22e09c69b99..0f1869e1cc1 100644 --- a/server/sonar-docs/README.md +++ b/server/sonar-docs/README.md @@ -14,7 +14,7 @@ We use an augmented GitHub markdown syntax: - Install nodejs v10, which is the current LTS version. - Install https://yarnpkg.com/en - Set the following properties in `~/.gradle/gradle.properties`: - - `artifactoryUsername=` + - `artifactoryUsername=` - `artifactoryPassword=` - Run the following to set up the dev servers: @@ -114,10 +114,10 @@ url: /sonarcloud-pricing/ --- ``` -** Metadata conventions** +**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 required, and should start and end with `/` ### Includes @@ -328,7 +328,7 @@ You can include multiple boxes per page, if needed. ## URL Rewrites The code in this section replaces 0-n pages that used to live on Confluence. To ease the transition (search results, user bookmarks, etc.) we've put server-level redirects in place from the old Confluence pages to the static site. Those redirects are maintained here: -* https://github.com/SonarSource/marlin/blob/master/ansible/installs/prod/docs.yml -* https://github.com/SonarSource/marlin/blob/master/ansible/installs/prod/docs3.yml +* https://github.com/SonarSource/marlin/blob/master/ansible/installs/docs.yml +* https://github.com/SonarSource/marlin/blob/master/ansible/installs/docs3.yml * https://github.com/SonarSource/test-infra/blob/master/tests/docs_sonarqube_org_test.py diff --git a/server/sonar-docs/src/pages/extend/adding-scm.md b/server/sonar-docs/src/pages/extend/adding-scm.md index 970d7ebae8b..069af4b5122 100644 --- a/server/sonar-docs/src/pages/extend/adding-scm.md +++ b/server/sonar-docs/src/pages/extend/adding-scm.md @@ -9,4 +9,4 @@ SonarQube Scanner uses information from the project's SCM, if available, to: * Display the most recent commit on each line the code viewer. ![Commit info is available from the margin of the code viewer](/images/commit-info-in-code-viewer.png) -The only required SCM command is "blame", which gets the last committer of each line for a given file. This command is executed by a SonarQube plugin through the extension point org.sonar.api.batch.scm.ScmProvider. See the multiple existing plugins, for instance [Git](https://docs.sonarqube.org/display/SONAR/Git+Integration), for more details. +The only required SCM command is "blame", which gets the last committer of each line for a given file. This command is executed by a SonarQube plugin through the extension point `org.sonar.api.batch.scm.ScmProvider`. See the embedded SCM integrations, for instance [Git](/analysis/scm-integration/), for more details. diff --git a/server/sonar-docs/src/pages/instance-administration/security.md b/server/sonar-docs/src/pages/instance-administration/security.md index b500b71a1ef..b3065e29342 100644 --- a/server/sonar-docs/src/pages/instance-administration/security.md +++ b/server/sonar-docs/src/pages/instance-administration/security.md @@ -109,7 +109,7 @@ The way authorization is implemented in SonarQube is pretty standard. It is poss To administer groups and users, choose **Administration > Security**, and use the sub-menu items. ### User -Multiple integrations that allow the delegation of authentication are available (see the [Plugin Library](https://redirect.sonarsource.com/doc/plugin-library.html) and [Other Plugins](https://docs.sonarqube.org/display/PLUG/Other+Plugins), but you can manually create and edit users at **[Settings > Security > Users](/#sonarqube-admin#/admin/users)**. For manually-created users, login and password can be set at creation. Manually-created users can edit their passwords. +Multiple integrations that allow the delegation of authentication are available (see the [Plugin Version Matrix](/instance-administration/plugin-version-matrix/)), but you can manually create and edit users at **[Settings > Security > Users](/#sonarqube-admin#/admin/users)**. For manually-created users, login and password can be set at creation. Manually-created users can edit their passwords. During both user creation and edit, you can set an account's screen name, email address. User login and email address will be implicitly recognized by the Issue Assignment feature as SCM accounts if applicable, but you can set additional SCM accounts explicitly. diff --git a/server/sonar-docs/src/pages/setup/install-cluster.md b/server/sonar-docs/src/pages/setup/install-cluster.md index 232d0edc426..f855de57cdb 100644 --- a/server/sonar-docs/src/pages/setup/install-cluster.md +++ b/server/sonar-docs/src/pages/setup/install-cluster.md @@ -187,7 +187,7 @@ The following is an example of the default SonarQube cluster installation proces 1. On a single application node of the cluster, download and install SonarQube Data Center Edition, following the usual [Installing the Server](/setup/install-server/) documentation. 2. Add cluster-related parameters to `$SONARQUBE_HOME/conf/sonar.properties`. -3. This is also a good opportunity to install plugins. Download and place a copy of each plugin JAR in `$SONARQUBE_HOME/extensions/plugins`. Be sure to check compatibility with your SonarQube version using the [Plugin Version Matrix](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix). +3. This is also a good opportunity to install plugins. Download and place a copy of each plugin JAR in `$SONARQUBE_HOME/extensions/plugins`. Be sure to check compatibility with your SonarQube version using the [Plugin Version Matrix](/instance-administration/plugin-version-matrix/). 4. Zip the directory `$SONARQUBE_HOME`. This archive is a customized SonarQube Data Center Edition package that can be copied to other nodes. **Test configuration on a single node:** diff --git a/server/sonar-docs/src/pages/setup/overview.md b/server/sonar-docs/src/pages/setup/overview.md index b4d2eee7dff..91b05962368 100644 --- a/server/sonar-docs/src/pages/setup/overview.md +++ b/server/sonar-docs/src/pages/setup/overview.md @@ -10,7 +10,7 @@ To try out the SonarQube platform, follow the [Try Out SonarQube](/setup/get-sta To install a production instance, read the [Requirements](/requirements/requirements/), and then follow the [Installation Guide](/setup/install-server/). ### After the installation -After your server is up and running, you'll need to install one or more [SonarScanners](https://docs.sonarqube.org/display/SCAN) on the machines where analysis will be performed. +After your server is up and running, you'll need to install one or more [SonarScanners](/analysis/overview/) on the machines where analysis will be performed. ### Upgrade your production instance -To upgrade your production instance, read the [Upgrade Guide](/setup/upgrading/) and the relevant, version-specific upgrade notes. \ No newline at end of file +To upgrade your production instance, read the [Upgrade Guide](/setup/upgrading/) and the relevant, version-specific upgrade notes. diff --git a/server/sonar-docs/src/pages/setup/upgrading.md b/server/sonar-docs/src/pages/setup/upgrading.md index 2ef48b33106..69033a4800a 100644 --- a/server/sonar-docs/src/pages/setup/upgrading.md +++ b/server/sonar-docs/src/pages/setup/upgrading.md @@ -15,7 +15,7 @@ During your upgrade, tables may be duplicated to speed up the migration process. ## Upgrading from the ZIP file 1. Download and unzip the SonarQube distribution of your edition in a fresh directory, let's say `$NEW_SONAR_HOME` -2. If you're using third-party plugins, Manually install plugins that are compatible with your version of SonarQube. Use the [Compatibility Matrix](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix) to ensure that the versions you install are compatible with your server version. Simply copying plugins from the old server to the new is not recommended; incompatible or duplicate plugins could cause startup errors. Analysis of all languages provided by your edition is available by default without plugins. +2. If you're using third-party plugins, Manually install plugins that are compatible with your version of SonarQube. Use the [Plugin Version Matrix](/instance-administration/plugin-version-matrix/) to ensure that the versions you install are compatible with your server version. Simply copying plugins from the old server to the new is not recommended; incompatible or duplicate plugins could cause startup errors. Analysis of all languages provided by your edition is available by default without plugins. 3. Update the contents of `sonar.properties` and `wrapper.conf` files (in `$NEW_SONAR_HOME/conf`) with the settings of the related files in the `$OLD_SONAR_HOME/conf` directory (web server URL, database, ldap settings, etc.). Do not copy-paste the old files. If you are using the Oracle DB, copy its JDBC driver into `$NEW_SONAR_HOME/extensions/jdbc-driver/oracle` 4. Stop your old SonarQube Server @@ -26,7 +26,7 @@ If you are using the Oracle DB, copy its JDBC driver into `$NEW_SONAR_HOME/exten ## Upgrading from the Docker image [[info]] -| If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions volume from the previous version to avoid moving plugins or drivers. Use the [Compatibility Matrix](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix) to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins. +| If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions volume from the previous version to avoid moving plugins or drivers. Use the [Plugin Version Matrix](/instance-administration/plugin-version-matrix/) to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins. To upgrade SonarQube using the Docker image: @@ -62,7 +62,7 @@ No specific Docker operations are needed, just use the new tag. ## Upgrading from the Helm Chart [[info]] -| If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions PVC from the previous version to avoid moving plugins or drivers. Use the [Compatibility Matrix](https://docs.sonarqube.org/display/PLUG/Plugin+Version+Matrix) to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins. +| If you're upgrading with an Oracle database or you're using plugins, you can reuse your extensions PVC from the previous version to avoid moving plugins or drivers. Use the [Plugin Version Matrix](/instance-administration/plugin-version-matrix/) to ensure that your plugins are compatible with your version. Analysis of all languages provided by your edition is available by default without plugins. To upgrade SonarQube using our official Helm Chart: @@ -130,4 +130,4 @@ sc config SonarQube binPath= "\"$NEW_SONAR_HOME\bin\windows-x86-64\wrapper.exe\" ``` ### Rebuilding indexes -If your upgrade requires the rebuild of Elasticsearch indexes, your projects and applications will become available as they are reindexed. Portfolios won't be available until all projects are indexed. \ No newline at end of file +If your upgrade requires the rebuild of Elasticsearch indexes, your projects and applications will become available as they are reindexed. Portfolios won't be available until all projects are indexed. -- 2.39.5