]> source.dussan.org Git - sonarqube.git/commitdiff
Simplify Bitbucket Cloud "Get Started" docs
authorFabrice Bellingard <fabrice.bellingard@sonarsource.com>
Wed, 13 Feb 2019 10:46:37 +0000 (11:46 +0100)
committerSonarTech <sonartech@sonarsource.com>
Mon, 18 Feb 2019 19:20:56 +0000 (20:20 +0100)
server/sonar-docs/README.md
server/sonar-docs/src/pages/sonarcloud/integrations/bitbucketcloud.md
server/sonar-docs/src/pages/sonarcloud/integrations/github.md
server/sonar-docs/src/pages/sonarcloud/integrations/vsts.md

index 29f7261b756d24b0bd541d680521814d806a04f0..6e28a204fd88514ecc6a76373383a6cc95e30a9e 100644 (file)
@@ -102,14 +102,16 @@ All urls _must_ end with a trailing slash (`/`).
 
 Each documentation file should contain a header at the top of the file delimited by "---" top and bottom. The header holds file metadata:
 
-* The `title` tag defines the title of the page for the index
+* The `title` tag defines the title of the page.
 * The `url` tag is required and defines the path at which to publish the page. Reminder: end this with a trailing slash.
+* The `nav` tag is optional and controls the title of the page inside the navigation tree.
 
 Ex.:
 
 ```
 ---
 title: Demo page
+nav: Demo
 url: /sonarcloud-pricing/
 ---
 ```
index d723cd11c4d106c871ea0136828b96ac7c6d121b..bb14da54c6238a7ec0e3be731091046c53b1fde1 100644 (file)
@@ -1,25 +1,28 @@
 ---
-title: Bitbucket Cloud
+title: Get started with Bitbucket Cloud
+nav: Bitbucket Cloud
 url: /integrations/bitbucketcloud/
 ---
 
-You can connect to SonarCloud using your Bitbucket Cloud account. On the [login page](/#sonarcloud#/sessions/new), just click on the "Log in with Bitbucket" button.
-
-## Install SonarCloud add-on for Bitbucket Cloud
-
-Our Bitbucket Cloud application allows users to automate the SonarCloud analysis with Pipelines. It also allows users to view their SonarCloud metrics directly on Bitbucket Cloud via our Code Quality widget and the decoration of pull-requests.
-
-In Bitbucket Cloud, go to your team's "Settings > Find integrations" page, search for "SonarCloud" in the "Code Quality" category and click on "Add" to install the application.
+## Sign up and set up your first project
+1. On the [login page](/#sonarcloud#/sessions/new), click on the "Log in with Bitbucket" button and connect to SonarCloud using your Bitbucket Cloud account.
+2. Click on "Analyze your code" and follow the path to set up a first project
+3. You will be asked to install the SonarCould application on your team or user account, which will allow you to 
+  choose which repositories you want to analyze.
 
 ## Analyzing with Pipelines
 
-1.  On SonarCloud, once your project is created, generate a token to allow to publish analysis from Bitbucket Pipelines. To generate a token, follow the first step of the tutorial on the dashboard of the project, or go to your user security page.
+Once your project is created and initiated from the repository you selected:
+
+1. Generate a token to allow to publish analysis from Bitbucket Pipelines. To generate a token, follow the first step of the tutorial on the dashboard of the project, or go to your user security page.
 
-2.  On Bitbucket Cloud, go to the "Settings > Pipelines > Account variables" page of your team, and add a new SONAR_TOKEN variable that contains the value of the SonarCloud token (something like `9ad01c85336b265406fa6554a9a681a4b281135f`). **Make sure that you click on the "Lock" icon to encrypt and hide this token.**
+2. On Bitbucket Cloud, go to the "Settings > Pipelines > Account variables" page of your team, and add a new SONAR_TOKEN variable that contains the value of the SonarCloud token (something like `9ad01c85336b265406fa6554a9a681a4b281135f`).
+   * **Make sure that you click on the "Lock" icon to encrypt and hide this token.**
 
-3.  Edit the `bitbucket-pipelines.yml` file of your repository to trigger the SonarCloud analysis. If you have a Maven or Gradle project, the simplest way is to use our dedicated plugins. For most other projects, you need our command line scanner to trigger analyses. See [various example projects](https://bitbucket.org/account/user/sonarsource/projects/SAMPLES).
+3. Edit the `bitbucket-pipelines.yml` file of your repository to trigger the SonarCloud analysis. See [our various example projects](https://bitbucket.org/account/user/sonarsource/projects/SAMPLES) to see how to achieve this.
+   * Note: if you did not activate Pipelines prior to this step, you should go to the "Pipelines" menu entry on your repository to enable it.
 
-When a change on `bitbucket-pipelines.yml` is committed and pushed, Pipelines should automatically run a new build and therefore trigger the analysis of the repository. Shortly after, your project will appear on SonarCloud in your organization.
+Once those changes are pushed, Pipelines will automatically trigger analyses on the repository.
 
 ## Analyzing pull requests with Pipelines
 
index 2349f92964994be9b24ba187d55c2e9bfeb2966e..af328acaefb3aff432483d183b74d5ce278e1c0e 100644 (file)
@@ -1,5 +1,6 @@
 ---
-title: GitHub
+title: Get started with GitHub
+nav: GitHub
 url: /integrations/github/
 ---
 
index ac14a957fdf6f7d01ffd76a619c6943300c61cb9..f150d7ab20ae4eb2877b3606a5ebe521c3c90148 100644 (file)
@@ -1,5 +1,6 @@
 ---
-title: Azure DevOps
+title: Get started with Azure DevOps
+nav: Azure DevOps
 url: /integrations/vsts/
 ---