Skip to content

Commit 0f031a7

Browse files
Vincent Gegitbook-bot
Vincent Ge
authored andcommitted
GITBOOK-756: Repositioning
1 parent a72f006 commit 0f031a7

27 files changed

+252
-340
lines changed

code-quality/ci-setup/README.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

code-quality/ci-setup/manual-setup.md

Lines changed: 0 additions & 153 deletions
This file was deleted.

code-quality/code-quality.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: 'Metalinter for over 100 code checking tools: CLI, IDE, and on the web.'
2+
description: Metalinter for over 100 code checking tools.
33
---
44

55
# Overview
@@ -24,7 +24,7 @@ Maintaining consistency in open-source repos is hard. That's why Trunk Code Qual
2424

2525
{% hint style="danger" %}
2626
**Deprecation Warning**\
27-
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](setup-and-installation/prevent-new-issues/) page to migrate off these features.
27+
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](setup-and-installation/prevent-new-issues.md) page to migrate off these features.
2828
{% endhint %}
2929

3030
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Trunk CLI</strong></td><td>Initialize Code Quality in your projects using the Trunk CLI.</td><td></td><td><a href="setup-and-installation/initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>IDE Integration</strong></td><td>Initialize Code Quality in your projects using a VSCode extension.</td><td></td><td><a href="ide-integration/">ide-integration</a></td></tr></tbody></table>

code-quality/ide-integration/vscode.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ If Trunk has not initialized itself in single-player mode, then you will need to
1010

1111
![initialize trunk](https://static.trunk.io/assets/vscode_init_trunk.png)
1212

13-
or via the command line: just install the CLI and run `trunk init` in your repo.
14-
15-
* Install Trunk → `curl https://get.trunk.io -fsSL | bash`
16-
* Setup Trunk in your repo → `trunk init`
17-
* See and fix issues as you code in VSCode → **You're in the right place 👍**
18-
1913
### Features
2014

2115
#### Discovery

code-quality/overview/README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Trunk will install, manage, and run tools like linters and formatters for you. T
2424

2525
[Adopting new linters is a pain](https://trunk.io/blog/reasons-developers-hate-linters) because of the large amount of upfront configuration and fixes needed. Enabling a new linter or formatter in an old repo will yield thousands of issues, most of which might not have auto fixes.
2626

27-
Trunk supports [hold-the-line](how-does-it-work.md#hold-the-line) to lint only new issues introduced with a commit or PR, to let developers adopt new linters fast, focus on preventing new issues first, and[ report on existing issues nightly](../ci-setup/) to fix later. Waiting will only accumulate debt; stop debt accumulation immediately and fix as you code.
27+
Trunk supports [hold-the-line](how-does-it-work.md#hold-the-line) to lint only new issues introduced with a commit or PR, to let developers adopt new linters fast, focus on preventing new issues first, and[ report on existing issues nightly](../ci-setup/github-integration.md) to fix later. Waiting will only accumulate debt; stop debt accumulation immediately and fix as you code.
2828

2929
#### Linters take too long to run
3030

@@ -38,10 +38,6 @@ Many linters don't install neatly through a package manager, and for those that
3838

3939
Trunk Code Quality uses an extensible [plugin system](../../references/cli/configuration/plugins/), so you can define linters to [auto-enable](../../references/cli/configuration/lint/auto-enable.md) and [share linter configurations](../linters/shared-configs.md) to standardize across code bases.
4040

41-
#### Lack of consistent output and reporting
42-
43-
Every linter outputs differently. If you've got a backlog of issues like ESLint errors, OSV Scanner dependency vulnerabilities, poorly optimized images, and vulnerabilities in your Docker Config, you'd want to see them in an [organized report](../ci-setup/github-integration.md), sorted by severity or by file, with [consistent format](../../references/cli/configuration/lint/output.md). Trunk Code Quality can do this.
44-
4541
### Features
4642

4743
Trunk Code Quality helps address these issues by:
@@ -62,11 +58,7 @@ Trunk Code Quality speeds up static analysis by using a background daemon to che
6258

6359
#### **Time-consuming PR iteration and triage**
6460

65-
Trunk Code Quality speeds up PR iteration by showing the _same_ results locally and [on CI](../ci-setup/), improving PR triage. It can optionally also function as a [githooks manager](../../references/cli/getting-started/actions/git-hooks.md) to reject `git push`es unless they're passing `trunk check`.
66-
67-
#### **Lack of team visibility into the repo's health**
68-
69-
Trunk Code Quality improves team communication by providing a [web app](https://app.trunk.io/login?intent=code%20quality) for repo stats and [Slack notifications](../../integration-for-slack.md), ensuring everyone on the team is aware of the current health of your repo.
61+
Trunk Code Quality speeds up PR iteration by showing the _same_ results locally and [on CI](../setup-and-installation/prevent-new-issues.md), improving PR triage. It can optionally also function as a [githooks manager](../../references/cli/getting-started/actions/git-hooks.md) to reject `git push`es unless they're passing `trunk check`.
7062

7163
### Components
7264

@@ -76,4 +68,3 @@ Trunk Code Quality has many components that fit into different stages of your de
7668
* **In cloud development environments:** Trunk can be used in [GitHub Codespaces](../../cli/configuration/github-codespaces.md).
7769
* **Before committing and pushing,** Trunk can automatically run linters and formatters using Git hooks.
7870
* **On PRs and in CI:** Using our GitHub integration, setting up your own GitHub workflows, or in your own CI environments.
79-
* **Reporting and analytics**: Using the Trunk Web App.

code-quality/overview/how-does-it-work.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,4 @@ This can be overridden by defining your own plugin repo to import, overriding in
5454

5555
Trunk works in CI. Trunk Code Quality provides [GitHub integration](../ci-setup/github-integration.md) and can run in any other CI environment. This lets you check Code Quality in every PR with consistent config and consistent results.
5656

57-
[Learn more about Code Quality in CI.](../ci-setup/)
58-
59-
### Nightly reports
60-
61-
Trunk Code Quality allows you to [upload results](../ci-setup/manual-setup.md#other-providers) to the [Trunk Web App](https://app.trunk.io/login?intent=code%20quality), which provides a dashboard to view your current code base issues and track code base health over time.
62-
63-
[Learn more about nightly reporting.](how-does-it-work.md#nightly-reports)
57+
[Learn more about Code Quality in CI.](../setup-and-installation/prevent-new-issues.md)

code-quality/setup-and-installation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
{% hint style="danger" %}
44
**Deprecation Warning**\
5-
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](prevent-new-issues/) page to migrate off these features.
5+
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](prevent-new-issues.md) page to migrate off these features.
66
{% endhint %}
77

88
Trunk Code Quality is easy to adopt for new and legacy projects alike. You can run Trunk Code Quality using your existing linter configurations, incrementally address existing problems, and prevent new issues from being committed to your repo.
99

1010
You can start using Code Quality in your repos in 4 steps.
1111

12-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Step 1: Initialize Trunk</strong></td><td>Initialize Trunk in your repo to generate Trunk config files and get linter recommendations based on your project's files.</td><td></td><td><a href="initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>Step 2: Check for issues</strong></td><td>Check for existing issues in your project. You can address problems up front, use <strong>hold-the-line</strong> to fix them incrementally, and configure ignores for irrelevant issues. </td><td></td><td><a href="deal-with-existing-issues.md">deal-with-existing-issues.md</a></td></tr><tr><td><strong>Step 3: Prevent New Issues</strong></td><td>Set up automated runs on commits, before pushes, and on PRs to prevent new issues from appearing in your repo.</td><td></td><td><a href="prevent-new-issues/">prevent-new-issues</a></td></tr><tr><td><strong>Step 4: Nightly Reports</strong></td><td>Code Standards evolve, and new vulnerabilities are discovered daily. Run regular Code Quality checks to discover issues in your repo.</td><td></td><td><a href="../ci-setup/github-integration.md">github-integration.md</a></td></tr></tbody></table>
12+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Step 1: Initialize Trunk</strong></td><td>Initialize Trunk in your repo to generate Trunk config files and get linter recommendations based on your project's files.</td><td></td><td><a href="initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>Step 2: Check for issues</strong></td><td>Check for existing issues in your project. You can address problems up front, use <strong>hold-the-line</strong> to fix them incrementally, and configure ignores for irrelevant issues. </td><td></td><td><a href="deal-with-existing-issues.md">deal-with-existing-issues.md</a></td></tr><tr><td><strong>Step 3: Prevent New Issues</strong></td><td>Set up automated runs on commits, before pushes, and on PRs to prevent new issues from appearing in your repo.</td><td></td><td><a href="prevent-new-issues.md">prevent-new-issues.md</a></td></tr></tbody></table>

0 commit comments

Comments
 (0)