aboutsummaryrefslogtreecommitdiffstats
path: root/server
diff options
context:
space:
mode:
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>2020-07-14 12:51:48 -0500
committersonartech <sonartech@sonarsource.com>2020-08-14 20:16:19 +0000
commit144814979bd4fd28963ca3e4b9b1c5aeff6aa0fe (patch)
tree4fb7495c4226e6098db28a64154613fe5c8b9430 /server
parent187597cbd491fff2718156633aab259c658ce830 (diff)
downloadsonarqube-144814979bd4fd28963ca3e4b9b1c5aeff6aa0fe.tar.gz
sonarqube-144814979bd4fd28963ca3e4b9b1c5aeff6aa0fe.zip
SONAR-13691 Update the landing page and move Architecture and Integration info
Diffstat (limited to 'server')
-rw-r--r--server/sonar-docs/src/images/SQ-instance-components.pngbin0 -> 92365 bytes
-rw-r--r--server/sonar-docs/src/images/dev-cycle.pngbin0 -> 60517 bytes
-rw-r--r--server/sonar-docs/src/pages/index.md119
-rw-r--r--server/sonar-docs/src/pages/project-administration/project-settings.md4
-rw-r--r--server/sonar-docs/src/pages/setup/install-server.md29
-rw-r--r--server/sonar-docs/src/pages/setup/overview.md15
-rw-r--r--server/sonar-docs/src/pages/user-guide/concepts.md5
-rw-r--r--server/sonar-docs/static/StaticNavigationTree.json1
8 files changed, 110 insertions, 63 deletions
diff --git a/server/sonar-docs/src/images/SQ-instance-components.png b/server/sonar-docs/src/images/SQ-instance-components.png
new file mode 100644
index 00000000000..948dc3701a3
--- /dev/null
+++ b/server/sonar-docs/src/images/SQ-instance-components.png
Binary files differ
diff --git a/server/sonar-docs/src/images/dev-cycle.png b/server/sonar-docs/src/images/dev-cycle.png
new file mode 100644
index 00000000000..c78a8f2cace
--- /dev/null
+++ b/server/sonar-docs/src/images/dev-cycle.png
Binary files differ
diff --git a/server/sonar-docs/src/pages/index.md b/server/sonar-docs/src/pages/index.md
index adc0c67b1b2..116e5621392 100644
--- a/server/sonar-docs/src/pages/index.md
+++ b/server/sonar-docs/src/pages/index.md
@@ -1,52 +1,81 @@
---
-title: Documentation
+title: SonarQube Documentation
url: /
---
-<!-- static -->
-
-[[info]]
-| **Welcome to the new SonarQube documentation**
-| If you're already running a SonarQube instance, this documentation is also available within SonarQube itself. Just look under the "?" in the top menu to be sure you're always looking at the right documentation for _your_ version!
-<!-- /static -->
+Welcome to the SonarQube documentation!
[SonarQube](http://www.sonarqube.org/)® is an automatic code review tool to detect bugs, vulnerabilities, and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
-Below are a few common scenarios. You can also navigate through and search the full documentation in the left pane.
-
-### I'm new to SonarQube
-* [Try out SonarQube ](/setup/get-started-2-minutes/).
-* Installing [the Server](/setup/install-server/).
-
-### I need to set up analysis
-* [Analyzing Source Code](/analysis/overview/)
-* [Branches](/branches/overview/)
-* [Pull Requests](/analysis/pull-request/)
-
-### I write code
-* Why [new code](/user-guide/clean-as-you-code/) is the most important
-* [Concepts](/user-guide/concepts/)
-* [Quality Gates](/user-guide/quality-gates/)
-* [Issues](/user-guide/issues/)
-
-### I administer a project
-* [Project Existence](/project-administration/project-existence/)
-* What's [included, excluded](/project-administration/narrowing-the-focus/) from analysis
-* [Webhooks](/project-administration/webhooks/)
-* [Project Settings](/project-administration/project-settings/)
-
-### I administer a SonarQube Instance
-* [Security](/instance-administration/security/)
-* [Notifications](/instance-administration/notifications/)
-* [Housekeeping](/instance-administration/housekeeping/)
-
-### I do DevOps
-* Installing a [production instance](/setup/install-server/).
-* [Upgrading](/setup/upgrading/)
-* [Monitoring](/instance-administration/monitoring/)
-* [Running a Cluster](/setup/operate-cluster/)
-
-### Stay in touch!
-* [Get help in the community](https://www.sonarqube.org/community/)
-* [Source code](https://github.com/SonarSource)
-* [Issue tracker](https://jira.sonarsource.com/)
+If you want to try out SonarQube, check out the [Try out SonarQube](/setup/get-started-2-minutes/) page for instructions on installing a local instance and analyzing a project.
+
+If you're ready to set up a production instance, check out the [Install the Server](/setup/install-server/) documentation.
+
+Otherwise, you can also find an overview and common scenarios below or navigate through and search the full documentation in the left pane.
+
+## Overview
+
+![SonarQube Instance Components](/images/dev-cycle.png)
+
+In a typical development process:
+1. Developers develop and merge code in an IDE (preferably using [SonarLint](https://www.sonarlint.org/) to receive immediate feedback in the editor) and check-in their code to their ALM.
+1. An organization’s continuous integration (CI) tool checks out, builds, and runs unit tests, and an integrated SonarQube scanner analyzes the results.
+1. The scanner posts the results to the SonarQube server which provides feedback to developers through the SonarQube interface, email, in-IDE notifications (through SonarLint), and decoration on pull or merge requests (when using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and above).
+
+## Installing, monitoring, and upgrading
+
+See the [installing](/setup/install-server/) and [upgrading](/setup/upgrading/) pages for setting up your production instance.
+
+When your instance is up and running, see the [Monitoring](/instance-administration/monitoring/) documentation for information on keeping your instance running smoothly.
+
+If you're using SonarQube Data Center Edition, see the [Configure & Operate a Cluster](/setup/operate-cluster/) documentation for more information on running your instance as a cluster.
+
+## Setting up analysis
+
+Analyzing your code starts with installing and configuring a SonarQube scanner. The scanner can either run on your build or as part of your continuous integration (CI) pipeline performing a scan whenever your build process is triggered. For more information, see [Analyzing Source Code](/analysis/overview/).
+
+### Analyzing branches
+
+Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze your branches in SonarQube, and ensure that your code quality is consistent all the way down to the branch level in your projects. For more information, see [Branch Analysis](/branches/overview/).
+
+### Analyzing pull requests
+
+Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can integrate SonarQube to be part of your pull or merge request process. Issuing a pull request can trigger a branch analysis and add pull request decoration to see your branch analysis directly in your ALM's interface in addition to the SonarQube interface. For more information, see the [Pull Request Analysis Overview](/analysis/pull-request/) and [Decorating Pull Requests](/analysis/pr-decoration/).
+
+## Writing Clean and Safe Code
+
+SonarQube gives you the tools you need to write clean and safe code:
+
+- [SonarLint](https://www.sonarlint.org/) – SonarLint is a companion product that works in your editor giving immediate feedback so you can catch and fix issues before they get to the repository.
+- [Quality Gate](/user-guide/quality-gates/) – The Quality Gate lets you know if your project is ready for production.
+- [Clean as You Code](/user-guide/clean-as-you-code/) – Clean as You Code is an approach to code quality that eliminates a lot of the challenges that come with traditional approaches. As a developer, you focus on maintaining high standards and taking responsibility specifically in the New Code you're working on.
+- [Issues](/user-guide/issues/) – SonarQube raises issues whenever a piece of your code breaks a coding rule, whether it's an error that will break your code (bug), a point in your code open to attack (vulnerability), or a maintainability issue (code smell).
+- [Security Hotspots](/user-guide/security-hotspots/) – SonarQube highlights security-sensitive pieces of code that need to be reviewed. Upon review, you'll either find there is no threat or you need to apply a fix to secure the code.
+
+## Administering a Project
+
+If you have the **Create Projects** permission (a global administrator can set permissions at **Administration > Security > Global Permissions**), you can create and administer projects. See [Project Settings](/project-administration/project-settings/) for general information on setting up projects.
+
+A project is automatically added on the first analysis. However, you can provision projects (set up permissions, Quality Profiles, etc.) before running the first analysis. See [Project Existence](/project-administration/project-existence/) for more information on provisioning a project and handling provisioned projects.
+
+You also want to make sure SonarQube's results are relevant. To do this you need to [Narrowing the Focus](/project-administration/narrowing-the-focus/) or configure what to analyze for each project.
+
+You can also set up [Webhooks](/project-administration/webhooks/) to notify external services when a project analysis is complete.
+
+## Administering an Instance
+
+If you're a global administrator, you can set up authentication, administrator access, and authorization. See [Security](/instance-administration/security/) for more information.
+
+You can also set up email [notifications](/instance-administration/notifications/) that developers can subscribe to that are sent at the end of each analysis.
+
+When you run new analyses on your projects, some data is cleaned out of the database to save space and improve performance. See [Housekeeping](/instance-administration/housekeeping/) for information on what data is cleaned and how to change these settings.
+
+Starting in [Enterprise Edition](https://www.sonarqube.org/enterprise-edition/), you can set up [Portfolios](/user-guide/portfolios/) to get a high-level overview on the releasability of a group of projects.
+
+## Staying Connected
+
+Use the following links to get help and keep up with SonarQube:
+
+- [Get help in the community](https://www.sonarqube.org/community/)
+- [Source code](https://github.com/SonarSource)
+- [Issue tracker](https://jira.sonarsource.com/) \ No newline at end of file
diff --git a/server/sonar-docs/src/pages/project-administration/project-settings.md b/server/sonar-docs/src/pages/project-administration/project-settings.md
index 2c28bce1b24..dd3f2fc56f6 100644
--- a/server/sonar-docs/src/pages/project-administration/project-settings.md
+++ b/server/sonar-docs/src/pages/project-administration/project-settings.md
@@ -23,11 +23,11 @@ A project-level Background Tasks page is available at **Project Settings > Backg
### Deleting a Project
-#### Deleting a Single Project
+#### **Deleting a Single Project**
You can delete a project through **Project Settings > Deletion**.
-#### Deleting Multiple Projects
+#### **Deleting Multiple Projects**
You can also delete multiple projects simultaneously from the global **Project Settings > Projects > Management**.
### Updating the Project Key
diff --git a/server/sonar-docs/src/pages/setup/install-server.md b/server/sonar-docs/src/pages/setup/install-server.md
index 29ac4afab86..e0cd5df3459 100644
--- a/server/sonar-docs/src/pages/setup/install-server.md
+++ b/server/sonar-docs/src/pages/setup/install-server.md
@@ -3,7 +3,34 @@ title: Install the Server
url: /setup/install-server/
---
-## Installing the Database
+## Overview
+
+This section describes a single-node SonarQube instance. For details on clustered setup, see [Install the Server as a Cluster](/setup/install-cluster/).
+
+### Instance components
+
+A SonarQube instance comprises three components:
+
+![SonarQube Instance Components](/images/SQ-instance-components.png)
+
+1. The SonarQube server running the following processes:
+ - a web server that serves the SonarQube user interface.
+ - a search server based on Elasticsearch.
+ - the compute engine in charge of processing code analysis reports and saving them in the SonarQube database.
+
+2. The database to store the following:
+ - Metrics and issues for code quality and security generated during code scans.
+ - The SonarQube instance configuration.
+
+3. One or more scanners running on your build or continuous integration servers to analyze projects.
+
+### Hosts and locations
+
+For optimal performance, the SonarQube server and database should be installed on separate hosts, and the server host should be dedicated. The server and database hosts should be located in the same network.
+
+All hosts must be time-synchronized.
+
+## Installing the database
Several [database engines](/requirements/requirements/) are supported. Be sure to follow the requirements listed for your database. They are real requirements not recommendations.
diff --git a/server/sonar-docs/src/pages/setup/overview.md b/server/sonar-docs/src/pages/setup/overview.md
index 5b3c8752f75..b4d2eee7dff 100644
--- a/server/sonar-docs/src/pages/setup/overview.md
+++ b/server/sonar-docs/src/pages/setup/overview.md
@@ -3,17 +3,14 @@ title: Overview
url: /setup/overview/
---
-<!-- sonarqube -->
-### Get Started in Two Minutes
-To give the SonarQube Platform a quick try, follow the [Get Started in Two Minutes Guide](/setup/get-started-2-minutes/).
+### Try out SonarQube
+To try out the SonarQube platform, follow the [Try Out SonarQube](/setup/get-started-2-minutes/) guide.
-### Install a Production Instance
+### Install a production instance
To install a production instance, read the [Requirements](/requirements/requirements/), and then follow the [Installation Guide](/setup/install-server/).
-### After the Installation
+### 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.
-### Upgrade your Production Instance
-To upgrade your production instance, read the [Upgrade Guide](/setup/upgrading/) and the relevant, version-specific upgrade notes.
-
-<!-- /sonarqube -->
+### 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
diff --git a/server/sonar-docs/src/pages/user-guide/concepts.md b/server/sonar-docs/src/pages/user-guide/concepts.md
index a04d5735b13..7ee1d5368b0 100644
--- a/server/sonar-docs/src/pages/user-guide/concepts.md
+++ b/server/sonar-docs/src/pages/user-guide/concepts.md
@@ -3,8 +3,6 @@ title: Concepts
url: /user-guide/concepts/
---
-
-<!-- sonarqube -->
## Architecture
| Concept | Definition |
| -------- | ------------------------------------------------------------------------------------- |
@@ -12,9 +10,6 @@ url: /user-guide/concepts/
| Database | Stores configuration and **snapshots** |
| Server | Web interface that is used to browse **snapshot** data and make configuration changes |
-See also the [SonarQube Platform Overview](/architecture/architecture-integration/).
-<!-- /sonarqube -->
-
## Quality
| Concept | Definition |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json
index 8542b08c480..7c869407a00 100644
--- a/server/sonar-docs/static/StaticNavigationTree.json
+++ b/server/sonar-docs/static/StaticNavigationTree.json
@@ -1,6 +1,5 @@
[
"/setup/get-started-2-minutes/",
- "/architecture/architecture-integration/",
{
"title": "Requirements",
"children": [