mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 20:32:51 +08:00
7eb17bccca
* Set every page to have defaults of 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/enterprise-licensing pages to have 'Enterprise' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/recorded-queries pages to have labels cloud,enterprise * Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set administration/stats-and-license pages to have labels cloud,enterprise * Set alerting pages to have labels cloud,enterprise,oss * Set breaking-changes pages to have labels cloud,enterprise,oss * Set dashboards pages to have labels cloud,enterprise,oss * Set datasources pages to have labels cloud,enterprise,oss * Set explore pages to have labels cloud,enterprise,oss * Set fundamentals pages to have labels cloud,enterprise,oss * Set introduction/grafana-cloud pages to have labels cloud Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix introduction pages products Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set panels-visualizations pages to have labels cloud,enterprise,oss * Set release-notes pages to have labels cloud,enterprise,oss * Set search pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss * Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise * Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Set troubleshooting pages to have labels cloud,enterprise,oss * Set whatsnew pages to have labels cloud,enterprise,oss * Apply updated labels from review Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
78 lines
2.3 KiB
Markdown
78 lines
2.3 KiB
Markdown
---
|
||
description: Internal docs on how to setup the plugin spellcheck
|
||
draft: true
|
||
labels:
|
||
products:
|
||
- enterprise
|
||
- oss
|
||
title: Configuring plugin spellcheck
|
||
---
|
||
|
||
# Configuring plugin spellcheck
|
||
|
||
> ℹ️ This process is applicable only for grafana maintained plugins and only if the plugins are activated in drone.grafana.net for CI process.
|
||
|
||
## What it is and why it is required
|
||
|
||
The spellcheck CI step performs basic spellcheck against the plugin code and documentation.\
|
||
It helps us to avoid showing things like this to our customers:
|
||
|
||
|
||
|
||
At the moment spellcheck is mandatory for all internal plugins.
|
||
|
||
Under the hood, the pipeline uses [cspell npm package](https://www.npmjs.com/package/cspell) to perform the spellcheck.
|
||
|
||
## Steps to configure spellcheck
|
||
|
||
If you ended up here following the link from the failing CI then most probably you don't have spellcheck configured for your plugin. Follow the below steps to set it up.
|
||
|
||
1. Install cspell package to your plugin's repo:
|
||
|
||
```bash
|
||
yarn add -D cspell@6.13.3
|
||
```
|
||
|
||
3. Add `spellcheck` command to the `scripts` section in `package.json` of your plugin:
|
||
|
||
```
|
||
"spellcheck": "cspell -c cspell.config.json \"**/*.{ts,tsx,js,go,md,mdx,yml,yaml,json,scss,css}\""
|
||
```
|
||
|
||
3. Create a `cspell.config.json` file in the repo root folder and add a basic config there:
|
||
|
||
```json
|
||
{
|
||
"ignorePaths": [
|
||
"coverage/**",
|
||
"cypress/**",
|
||
"dist/**",
|
||
"go.sum",
|
||
"mage_output_file.go",
|
||
"node_modules/**",
|
||
"provisioning/**/*.yaml",
|
||
"src/dashboards/*.json",
|
||
"**/testdata/**/*.json",
|
||
"**/testdata/**/*.jsonc",
|
||
"vendor/**",
|
||
"cspell.config.json",
|
||
"package.json",
|
||
"yarn.lock",
|
||
"docker-compose*.yaml",
|
||
"docker-compose*.yml"
|
||
],
|
||
"ignoreRegExpList": [
|
||
// ignore multiline imports
|
||
"import\\s*\\((.|[\r\n])*?\\)",
|
||
// ignore single line imports
|
||
"import\\s*.*\".*?\""
|
||
],
|
||
"words": ["grafana", "datasource", "datasources"]
|
||
}
|
||
```
|
||
|
||
4. Run `yarn spellcheck` to see if there are any misspellings
|
||
5. If errors found, either fix them or add to `ignorePaths` or `words` section of the `cspell.config.json` created earlier
|
||
|
||
Sample PR to add spellcheck to your repo: https://github.com/grafana/athena-datasource/pull/185/files
|