[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #457: docs: sonarqube metrics and update some docs

["Startrekzky (via GitHub)" <gi...@apache.org>]

Startrekzky commented on code in PR #457:
URL: https://github.com/apache/incubator-devlake-website/pull/457#discussion_r1126243301


##########
docs/Metrics/CQCode.md:
##########
@@ -0,0 +1,34 @@
+---
+title: "Code Quality Code"
+description: >
+  Code Quality Code
+sidebar_position: 39
+---
+
+## What is this metric?
+
+It includes the number of lines of code, number of bugs, vulnerabilities, code smells, security hotspots, test coverage percentage, and duplication percentage.
+
+## Why is it important?
+
+It summarizes and analyzes the file metrics in SonarQube, which can help understand the quality status of the project. These indicators can be used to evaluate the code quality of the project, find out potential problems and fix them, and improve the maintainability and reliability of the code. readability and reliability. It helps teams better manage and maintain a project's codebase.

Review Comment:
   ... and improve the maintainability and reliability of the code, readability, and reliability.



##########
docs/GettingStarted/DockerComposeSetup.md:
##########
@@ -17,25 +16,23 @@ sidebar_position: 1
 
 1. Download `docker-compose.yml` and `env.example` from [latest release page](https://github.com/apache/incubator-devlake/releases/latest) into a folder.
 2. Rename `env.example` to `.env`. For Mac/Linux users, please run `mv env.example .env` in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s).
-3. If [Docker v2.13.0+](https://docs.docker.com/get-docker) Run `docker compose up -d` to launch DevLake or else Run `docker-compose up -d`.
+3. If the docker desktop version installed by the user is too low to use `docker compose up -d`, please use `docker-compose up -d`.
 
 ## Collect data and view dashboards
 
 1. Visit `config-ui` at `http://localhost:4000` in your browser to configure DevLake and collect data.
    - Please follow the [tutorial](Configuration/Tutorial.md)
    - `devlake` container takes a while to fully boot up. If `config-ui` complains about API being unreachable, please wait a few seconds and refresh the page.
-2. To view dashboards, click *View Dashboards* button in the top left corner, or visit `localhost:3002` (username: `admin`, password: `admin`).
+2. To view dashboards, click _View Dashboards_ button in the top left corner, or visit `localhost:3002` (username: `admin`, password: `admin`).

Review Comment:
   on the top left corner



##########
docs/Metrics/CQCode.md:
##########
@@ -0,0 +1,34 @@
+---
+title: "Code Quality Code"

Review Comment:
   Why is it called 'Code Quality Code'?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org