Skip to content

Commit 55c5f68

Browse files
authored
Merge pull request #9 from Exlint/EXL-132
[EXL-132] docs: 📘 Changed Group to Compliance
2 parents 4eff52f + 311ef35 commit 55c5f68

File tree

16 files changed

+9612
-13129
lines changed

16 files changed

+9612
-13129
lines changed

docs/ci/github-action/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ import styles from './styles.module.css';
1212
The [Exlint Action](https://github.com/Exlint/actions) is a GitHub Action that allows you to integrate Exlint into your CI (Continuous Integration) workflow.
1313
It can help you improve the quality of your code by catching errors and potential bugs, enforcing coding standards, and identifying security vulnerabilities.
1414

15-
To use the Exlint Action, you must have a token and a group configured. You can get your token for CI usage on the secret management page of [app.exlint.io](https://app.exlint.io).
15+
To use the Exlint Action, you must have a token and a compliance configured. You can get your token for CI usage on the secret management page of [app.exlint.io](https://app.exlint.io).
1616
Read more about creating secrets [here](/setup/secret-management)
1717

1818
To add the Exlint Action to your workflow, include the following in your config file:
1919

2020
```yaml title="Github Action"
2121
- uses: Exlint/[email protected]
2222
with:
23-
# Your configured group ID - Required
24-
groupId: ''
23+
# Your configured compliance ID - Required
24+
complianceId: ''
2525
# Your token for CI - Required
2626
token: ''
2727
```
2828
29-
The Exlint Action will then run Exlint on your codebase and check for any issues or violations of the rules specified in your group.
29+
The Exlint Action will then run Exlint on your codebase and check for any issues or violations of the rules specified in your compliance.

docs/data-privacy/user-account-data/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ At Exlint, we take data privacy seriously.
1313
When it comes to user and account data, we want to ensure that our users understand what information we collect and how it is used.
1414

1515
It's important to notice that if you are using the Exlint app, in order to use the service we need you to have an account with us.
16-
This account includes personal data such as your email address and also the groups you created on the app.
16+
This account includes personal data such as your email address and also the compliances you created on the app.
1717
This information is necessary for us to provide you with access to the Exlint service and to communicate with you regarding your account and usage of the service.
1818

1919
We also collect usage data related to your account, such as the number of times you run Exlint and the results of those runs.

docs/setup/cli-argument/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Exlint's command-line interface (CLI) allows you to run Exlint on your codebase
1515

1616
`auth`: This argument is used to authenticate your Exlint account. You will be prompted to enter your API key.
1717

18-
`use`: This argument is used to specify the group you want to run Exlint on using its unique ID. The group ID can be found on the Exlint dashboard.
18+
`use`: This argument is used to specify the compliance you want to run Exlint on using its unique ID. The compliance ID can be found on the Exlint dashboard.
1919

2020
`run`: This argument is used to run Exlint on your codebase. The `--fix` or `-f` flag can be used to automatically fix any issues found by Exlint.
2121

@@ -37,10 +37,10 @@ To authenticate your Exlint account, you can use the following command:
3737
exlint auth
3838
```
3939

40-
To use Exlint with a specific group, you can use the following command:
40+
To use Exlint with a specific compliance, you can use the following command:
4141

4242
```bash
43-
exlint use <group-id>
43+
exlint use <compliance-id>
4444
```
4545

4646
To run Exlint and automatically fix any issues found, you can use the following command:
@@ -50,5 +50,5 @@ exlint run --fix
5050
```
5151

5252
:::info
53-
Please note that if you are using the `run` command, you should have previously used the `use` command to specify the group you want to run exlint on.
53+
Please note that if you are using the `run` command, you should have previously used the `use` command to specify the compliance you want to run exlint on.
5454
:::

docs/setup/cli-output/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ import Tabs from '@theme/Tabs';
99
import TabItem from '@theme/TabItem';
1010
import styles from './styles.module.css';
1111

12-
Exlint's `run` command allows you to execute the linting and scanning of your code using the policies in a specific group.
13-
The output of the command will display the results of each policy in the group, similar to running the linter or formatter for each library separately.
12+
Exlint's `run` command allows you to execute the linting and scanning of your code using the policies in a specific compliance.
13+
The output of the command will display the results of each policy in the compliance, similar to running the linter or formatter for each library separately.
1414

1515
#### Examples
1616

17-
For example, when using the run command with a Group that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the group.
17+
For example, when using the run command with a Compliance that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the compliance.
1818
Here is an example of what the output may look like:
1919

2020
```bash title="Terminal"
+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Compliances",
3+
"position": 1
4+
}

docs/setup/compliances/index.mdx

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
sidebar_position: 1
3+
slug: /setup/compliances
4+
title: Compliances
5+
description: Exlint is a CLI tool that provides developers a quick and efficient application of multiple coding rule policies in multiple projects
6+
---
7+
8+
import styles from './styles.module.css';
9+
10+
Exlint Compliances allows you to manage and enforce coding standards across multiple projects and teams.
11+
12+
## What is an Exlint Compliance?
13+
14+
A Compliance is a set of configurable open-source policie that can be run together on any project in a matter of seconds.
15+
16+
## Creating a Compliance
17+
18+
To create a compliance, you'll need to visit the Compliance Management page on the Exlint Dashboard. Here, you can create a new compliance which is assigned with a unique identifier.
19+
Once you've created a compliance, you can configure its open-source policies to suit your needs.
20+
21+
Read more about configuring policies in the [policies section](/setup/policies).
22+
23+
## Running a Compliance
24+
25+
To use an Exlint Compliance in your project, you'll first need to configure an account on the Exlint Dashboard.
26+
27+
Once your account is set up, use `exlint auth` to authenticate your user with Exlint.
28+
29+
```bash
30+
exlint auth
31+
```
32+
33+
Now you can use the compliance in your project by running `exlint use <compliance_id>` in the terminal from your project's root folder.
34+
Exlint will configure your project with the required libraries and plugins for easy development. You can also see your linters in action if the linter support live linting.
35+
36+
```bash
37+
exlint use <compliance_id>
38+
```
39+
40+
:::tip
41+
You can easily switch compliance in your project by running the `exlint use <compliance_id>` command again!
42+
:::
43+
44+
To run the compliance policies over your project, you can use the command `exlint run`. Exlint will automatically use the configured compliance and output the policies' results.
45+
46+
exlint run [options]
47+
48+
You can also run the command with `--fix` or `-f` option. Providinig this option will make Exlint try to automatically fix your code issues.

docs/setup/groups/_category_.json

-4
This file was deleted.

docs/setup/groups/index.mdx

-48
This file was deleted.

docs/setup/policies/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ This document will guide you through the process of creating and using a Policy
1313
<!---
1414
## Policy in a nutshell
1515

16-
1. In the [Exlint Dashboard](https://app.exlint.io), select the `Group` you want to add a new Policy to.
16+
1. In the [Exlint Dashboard](https://app.exlint.io), select the `Compliance` you want to add a new Policy to.
1717
2. When creating a new Policy, select the open-source library you want to use for your Policy.
1818
3. Apply the appropriate `configurations` for your Policy, following the library guidelines.
1919
4. If the library has `rules` that can be applied, configure them as needed.
20-
5. Run the Policy's Group to get results! ([Running a Group](/setup/groups#running-a-group))
20+
5. Run the Policy's Compliance to get results! ([Running a Compliance](/setup/compliances#running-a-compliance))
2121
-->
2222

2323
## Configuring a Policy

docs/welcome/getting-started/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,16 @@ Use the following command to authenticate with your Exlint account:
7373
exlint auth
7474
```
7575

76-
### 2. Run an Exlint Group scan on your repository
76+
### 2. Run an Exlint Compliance scan on your repository
7777

78-
To use a group, copy its identifier and use it with the `use` command in the Exlint CLI.
78+
To use a compliance, copy its identifier and use it with the `use` command in the Exlint CLI.
7979
This will adjust your IDE and install necessary extensions and libraries.
8080

8181
```bash
82-
exlint use <group_id>
82+
exlint use <compliance_id>
8383
```
8484

85-
Run a group scan against your code using the `run` command:
85+
Run a compliance scan against your code using the `run` command:
8686

8787
```bash
8888
exlint run [options]

docs/welcome/how-exlint-works/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ import styles from './styles.module.css';
1212
# How Exlint works
1313

1414
Exlint is an open-source tool that helps in maintaining code quality and compliance by centralizing and streamlining coding standards.
15-
It works by running a set of open-source linters as a group on your codebase, and identifying any issues or violations of the specified rules.
15+
It works by running a set of open-source linters as a compliance on your codebase, and identifying any issues or violations of the specified rules.
1616

1717
When you run Exlint, it will automatically adjust your IDE and install any necessary extensions and libraries.
1818
This allows you to see the results of the linter checks directly in your code editor, including live-linting.
1919

20-
Exlint also provides a web-based dashboard app that allows you to view and manage your Exlint Groups, including adding and removing policies, and managing their configurations and rules.
20+
Exlint also provides a web-based dashboard app that allows you to view and manage your Exlint Compliances, including adding and removing policies, and managing their configurations and rules.
2121
With Exlint, you can easily centralize your compliance efforts and maintain a stardartized code quality across projects.
2222

2323
## What does Exlint analyze?
@@ -32,15 +32,15 @@ The types of issues that Exlint can analyze include:
3232
- Performance issues
3333
- Unused or deprecated code
3434

35-
The policies which you are using in an Exlint Group will specify what type of analysis it can perform and what type of error it can detect.
35+
The policies which you are using in an Exlint Compliance will specify what type of analysis it can perform and what type of error it can detect.
3636

3737
:::info
3838
Since Exlint is in beta, we only support a limited number of policies ([supported libraries](/supported-libraries)), but we're incrementally adding support for more policies and languages.
3939
:::
4040

4141
## Where does the analysis occur?
4242

43-
Exlint's group run process is entirely local using our open-source CLI.
43+
Exlint's compliance run process is entirely local using our open-source CLI.
4444
Your files and their contents are not sent to our backend, as the CLI performs the run on your machine.
4545
Only metadata is sent to our backend, which will be used to display your run history on your dashboard.
4646

docusaurus.config.js

+7-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ const config = {
5151
position: 'right',
5252
label: 'Sign up | Login',
5353
},
54+
{
55+
'href': 'https://github.com/Exlint/cli',
56+
'position': 'right',
57+
'className': 'header-github-link',
58+
'aria-label': 'GitHub repository',
59+
},
5460
],
5561
},
5662
footer: {
@@ -78,7 +84,7 @@ const config = {
7884
},
7985
{
8086
label: 'Setup',
81-
href: '/setup/groups',
87+
href: '/setup/compliances',
8288
},
8389
{
8490
label: 'CI',

0 commit comments

Comments
 (0)