From 048560b5069ae3faf5de0f96cbf133dc14fca75a Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Tue, 9 Nov 2021 16:04:11 -0600 Subject: [PATCH] SONAR-13434 Update documentation on project visiblity/badges --- .../src/pages/user-guide/project-page.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/server/sonar-docs/src/pages/user-guide/project-page.md b/server/sonar-docs/src/pages/user-guide/project-page.md index a083a91f3ac..bc42489745f 100644 --- a/server/sonar-docs/src/pages/user-guide/project-page.md +++ b/server/sonar-docs/src/pages/user-guide/project-page.md @@ -4,7 +4,7 @@ url: /user-guide/project-page/ --- -The Project Hompepage is the entry point of any project showing: +The Project Homepage is the entry point of any project showing: * the releasability status of the project * the current state of its quality * the quality of what has been produced since the start of the [New Code](/user-guide/clean-as-you-code/). @@ -14,13 +14,12 @@ The Project Page answers two questions: * can I release my project today? * if not, what should I improve to make the project pass the Quality Gate? -## Can I release today? - +## Quality Gate Since the [Quality Gate](/user-guide/quality-gates/) is your most powerful tool to enforce your quality policy, the page starts with the project's current Quality Gate status. If the project passes, a simple, green all-clear is shown. If not, details and drill-downs are immediately available to quickly identify what went wrong, with a section for each error condition showing what the current project value is and what it should be. As usual, you'll be able to click through on current values to get to drilldowns. -## What should I fix first? +## Prioritizing issues Because the best way to improve a project's quality is to catch and fix new problems before they become entrenched, the first view of a project is centered around New Code, which is highlighted in yellow on the right of the project homepage. The project space page shows a high-level summary of critical metrics, both current values and their New Code values. Just below the Quality Gate information, you have the numbers of old and new Issues in the Reliability and Security domains and then the Maintainability domain. Clicking on any figure on the page will take you to a detailed view, either in the Measures Page or the Issues Page. @@ -31,24 +30,25 @@ So, which issues should you go after first: Bugs, Vulnerabilities or Code Smells That's why you need to review your new Issues before jumping into resolving them. -## How can I ... -### How can I see project measures at a lower level? +## Viewing project measures at a lower level The project-level **Measures** menu item takes you to a dedicated sub-space where you see all project measures. Choose a measure for more details. Both list and tree views are available for each measure, and treemaps are available for percentages and ratings. -### How can I see all the issues in a project? +### Viewing all issues in a project The project-level **Issues** menu item takes you to a project-specific Issues page, where you can perform all the same actions you can at the higher level. On this page, you can easily narrow the list to the New Issues as set by your New Code definition, by selecting `New Code` in **Creation Date** facet. -### How can I see the project structure and code? +## Viewing project structure and code The project-level **Code** menu item takes you to an outline of your project structure. Drill down to see files in a directory, and choose a file to see its code. If your project is too large for easy exploration via drilling, the search feature on this page will help. While the global search in the main menu returns results from throughout the {instance} instance, the localized search on the code page is restricted to files and directories in the current project. -### How can I see the project activity / history? +## Viewing project activity and history The project-level **Activity** menu item takes you to the full list of code scans performed on your project since it was created in {instance}. By going there you can follow the evolution of the Quality Gate, see the changes of Quality Profiles and know when a given version of your code has been scanned. -### How can I easily spot the risks in a project? +## Spotting risks with visualizations Visualizations allow you to compare project components and quickly spot the ones that represent the greatest risks. The **Activity** page offers several pre-defined visualizations, and you can also create Custom visualizations with the metrics of your choice. -### How can I promote the health of my project to peers ? -If your project is publicly visible, then you can further promote its status in external tools and websites using native Project Badges. The **Get project badges** button on the homepage of a public project lets you choose/fine-tune your badge and gives you the URL for it. +## Using project badges to promote project health +You can promote your project's status in third-party tools and external websites using project badges. You can find the project badges by opening the **Project Information** menu in the upper-right corner of the project home page and clicking **Get project badges**. From here, you can choose and fine-tune your badge then copy the markdown text or image URL for it. Each project badge has a unique security token, which is required to make it accessible from third-party tools. + +Using project badges can expose sensitive information like your security rating and other metrics. Because of this, you should only use them in trusted environments. If a project badge URL is accessed by someone who should not have access to it, a project administrator can renew the project badge’s unique token by clicking the **Renew token** button. This invalidates any existing project badge URLs, and you'll have to update all locations where the badge is beingg used. \ No newline at end of file -- 2.39.5