Commit Graph

187 Commits

Author SHA1 Message Date
Jeff Levin
e4157361d9
documentation: update documentation for enabling tracing on a grafana instance (#56068)
This PR improves docs around enabling traces on grafana.
In order to enable tracing and get a traceID, you must set the address field in your config.ini

https://github.com/grafana/grafana/blob/main/contribute/engineering/backend/instrumentation.md#2-enable-tracing-in-grafana
2022-09-30 03:44:12 -04:00
Josh Hunt
615d86d902
Docs: Clarify contributions for translations (#55574)
* Docs: Clarify contributions for translations

* add comment to messages.po files
2022-09-27 10:21:23 -04:00
Torkel Ödegaard
c9b5acfefc
Frontend: Update frontend styleguide emotion example (#55608)
* Frontend: Update frontend styleguide emotion example

* Update styling guide

* Fixes

* Add back link to cx

* prettier

* Update contribute/style-guides/frontend.md

Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>

* prettier

Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
2022-09-23 08:22:16 +02:00
Marcus Efraimsson
919a26f389
Instrumentation: Guidance/conventions for logs, metrics and traces (#55562)
A first rough draft of adding some guidance/conventions for instrumenting 
Grafana with logs, metrics and traces together with how to run things 
locally to query/visualize logs, metrics and traces.

Closes #55470

Co-authored-by: Emil Tullstedt <emil.tullstedt@grafana.com>
Co-authored-by: Kristin Laemmert <mildwonkey@users.noreply.github.com>
Co-authored-by: Carl Bergquist <carl.bergquist@gmail.com>
2022-09-22 11:39:14 +02:00
Timur Olzhabayev
b5b41988cf
Docs: Deprecating packages_api and removing it from our pipelines (#54473) 2022-09-01 18:15:44 +02:00
Ryan McKinley
b483ac322f
Chore: replace React.FC<Props> with simple function component (#54123) 2022-08-24 16:54:34 -04:00
Alex Khomenko
b42f3e2c4c
A11y: Create Minimal Styleguide (#46948)
* First draft of the guide

* Fix Select part

* Move a11y PR guidelines

* Update contribute/create-pull-request.md

Co-authored-by: Maria Alexandra <239999+axelavargas@users.noreply.github.com>

Co-authored-by: Maria Alexandra <239999+axelavargas@users.noreply.github.com>
2022-08-11 14:00:38 +03:00
Josh Hunt
583490678b
update e2e docs to remove aria-label mentions (#52999) 2022-07-29 16:42:53 +01:00
Josh Hunt
62a3f2ed32
Chore: Align on 'internationalization' for feature name (#52585)
* rename internationalization docs

* Move localisation.tsx to internationalization/index.tsx
2022-07-21 06:31:08 -04:00
Torkel Ödegaard
dfce454eca
StyleGuide: Update frontend style guide (#52471)
We should not explicitly type the return type for React functional components.
2022-07-19 19:12:11 +02:00
Ursula Kallio
f1960b8ffc
Emphasize American English as source language (#52040) 2022-07-11 08:36:46 -04:00
Emil Tullstedt
0e7a495829
Docs: Update backend architecture contributor documentation (#51172)
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
2022-06-30 10:47:10 -04:00
Ashley Harrison
dd9bd7eec2
Chore: Add some betterer documentation (#51422)
* some betterer documentation

* slight tweak
2022-06-27 10:12:33 +01:00
Rob Whelan
a0f1a4b716
Docs: minor fixes to developer docs (#49790)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
2022-06-02 10:49:10 +02:00
Levente Balogh
e452785291
docs: clarify how PR titles should be formatted (#49682) 2022-06-01 10:44:38 +02:00
Eric Leijonmarck
f5d25c91f6
Docs: integration tests for using sqllite (#49455)
* Update developer-guide.md

* prettier formatting
2022-05-30 17:52:02 +10:00
Marcus Efraimsson
7e332d6f97
Chore: Add PR Check action enforcing changelog decision (#48728) 2022-05-05 11:38:46 +02:00
Jeff Levin
dac8abfc2c
chore: update contribution docs (#46942)
* add bus deprecation note in contribution docs
2022-05-04 10:38:04 -08:00
Josh Hunt
51c3d9d664
I18n: Developer documentation (#48415)
* Docs: Add developer documentation for localisation

* touch up docs

* more assertive

* add example for variable names

* Add naming conventions

* Rewrite 'what lingui does' section
2022-05-04 13:46:04 +01:00
Jeff Levin
38fc0c68e4
Update documentation to explicitly state we should not be putting migrations behind feature flags (#48663) 2022-05-03 15:10:59 -08:00
Adam Gabryś
a5b2ef3116
Doc: display the use active voice table correctly (#47302)
The table had in two rows an additional column. It was breaking the markdown formatting. The unused column has been removed and the table is displayed correctly now.
2022-04-05 11:11:10 -04:00
Selene
53799973f0
Documentation: Add using mock explanation for testing (#46360)
* Add using mock explanation for testing

* Update information of how to add go:generate in code

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2022-03-09 14:08:55 +01:00
Kevin Yu
1bf605fa83
Docs: Fix link to instructions for backporting a PR (#46211) 2022-03-07 07:10:18 -08:00
Ivana Huckova
647c5208d7
Devenv: Add documentation for integration tests (#46056)
* Add documentation for integration tests

* Update contribute/developer-guide.md
2022-03-02 10:12:50 +01:00
Levente Balogh
5e9faec428
Chore: guideline for dealing with breaking changes (#45128)
* Wip

* docs: add the first version of the breaking-changes guidelines

* chore: add a graphic about the CI workflow

* docs: add information about the CI workflow

* docs: add TOC to the breaking changes guideline

* chore: add a link in the comment to the guideline

* docs: fine-tune the style of the last paragraph

* docs: fix the way we reference `deprecationWarning()`

* fix: Prettier issues

* fix: fix Prettier issues

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: fix typo in the guideline

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: fix typo in the guideline

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: fix typo in the guideline

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* docs: update the wording in the guide

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>

* fix: fix prettier issues

Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
2022-02-11 09:29:57 +01:00
Dimitris Sotirakis
22eb2df602
E2E: Rename end-to-end-tests-server to grafana-server (#44249)
* Rename to grafana-server / move scripts into new directory

* Change grafana-server step command

* Change scripts paths

* Use test grabpl version

* Update run-suite script

* Further name updates

* Update grabpl version

* Update contribute/style-guides/e2e-core.md

Co-authored-by: Maria Alexandra <239999+axelavargas@users.noreply.github.com>

Co-authored-by: Maria Alexandra <239999+axelavargas@users.noreply.github.com>
2022-01-20 17:01:00 +00:00
Marcus Efraimsson
c1a9a36bd2
Chore: Add PR Check action enforcing backport decision (#43916)
Ref https://github.com/grafana/grafana-github-actions/pull/53
Ref https://github.com/grafana/grafana-release/issues/60
2022-01-12 13:09:25 +01:00
Ryan McKinley
b404aae9c3
Crawler: use existing render service to generate dashboard thumbnails (#43515)
Co-authored-by: Artur Wierzbicki <artur@arturwierzbicki.com>
2022-01-10 08:21:35 -08:00
Christopher Moyer
e1ad692cb3
docs: contributing updates (#41836)
* contributing updates first draft

* ran yarn prettier

* updated links

* removed test xref

* Update contribute/documentation/README.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
2022-01-04 16:14:32 -05:00
kay delaney
e4c84003fb
Docs: Add info about yarn pnp to developer guide (#43653)
* Docs: Add info about yarn pnp to developer guide

* Add missing space
2022-01-04 17:11:56 +00:00
Uchechukwu Obasi
eb4c3a4485
Update frontend guide to reflect new paradigm for api organization (#43435) 2021-12-23 09:28:41 +01:00
Marcus Efraimsson
85f134969e
Docs: Update merge a pull request guideline (#43273)
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-12-20 10:37:16 +01:00
Leonard Gram
c6021c8b4f
Build: building a local docker image using build-docker-dev no longer supported (#42563) 2021-12-01 14:34:28 +01:00
Marcus Efraimsson
d71cd65dbc
Chore: Update developer guide with instructions building from Windows (#42390)
In addition, removess copying of local directory in Dockerfile since that directory 
normally doesn't exist.
2021-12-01 10:34:00 +01:00
Joan López de la Franca Beltran
d49230d291
Grafana CLI Wire Runner (#41012)
* Set up Wire build graph

* Remove enterprise Wire set

* Move runner package outside commands

* Update Makefile (gen-go path)

* Minor prettier fix

* Include new Wire enterprise file into .gitignore

* Update Wire deps

* Update the grabpl version

Co-authored-by: Dan Cech <dcech@grafana.com>
2021-11-17 20:43:09 +01:00
Ashley Harrison
ed030f9c21
Chore: Set min node version in package.json to 16 (#41423)
* Update package.json

* Update build-container version

* Sign drone

* Update developer-guide

* kick drone

Co-authored-by: dsotirakis <sotirakis.dim@gmail.com>
Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
Co-authored-by: kay delaney <kay@grafana.com>
2021-11-10 14:23:10 +00:00
Mitch Seaman
d069f0900e
Update number of files that must be open (#41081)
2048 was not enough :)
2021-10-29 12:24:17 +02:00
Uchechukwu Obasi
e226480e06
Docs: update frontend style guide to highlight new function paradigm (#40347)
* docs: update frontend style guide to highlight new function paradigm

* docs: add section for default exports

* chore: some typo/syntax/grammar fixes

* chore: change new additions from rule to recommendation

* small typo fix
2021-10-19 08:30:43 +02:00
Will Browne
281d60095f
remove refs to --pure-lockfile (#40345) 2021-10-13 14:59:47 +02:00
Giordano Ricci
0ac81e9e47
Chore: remove volta references (#40275) 2021-10-12 12:39:54 +01:00
Andrej Ocenas
14d90b0cf8
Link to contributing docs and fix some image markdown examples (#39726) 2021-09-30 12:59:35 -04:00
Torkel Ödegaard
bc01c9cdbc
Prettier: Fix all markdown files and add markdown files to CI verify step (#39776) 2021-09-29 14:34:40 +02:00
Ursula Kallio
2d616285d9
Model imperative verbiage in PR examples. (#39041) 2021-09-27 21:36:53 +02:00
Maria Alexandra
1e946316e0
Pipeline: Fix flakiness on Pa11y CI (#39358)
* Pipeline: Add wait prop into pa11y configuration for all the pages

* Pa11y: Use e2e instance to generate html report local environment

* Pipeline: use pa11y-ci hash commit

* Pipeline: Update Pa11y thresholds

* Update package.json

* Update yarn.lock

Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
2021-09-23 15:02:30 +02:00
Maria Alexandra
1edd415ddf
Accessibility checks: Phase 2 - Adding Pa11y CI PR stage (#38556)
Co-authored-by: Hugo Häggmark <hugo.haggmark@grafana.com>
2021-09-14 13:23:17 +02:00
Alex Khomenko
9f833681b1
Docs: Fix typos in merge pull request guide (#38904)
* Fix typos

* Update contribute/merge-pull-request.md

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>

Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
2021-09-07 09:46:10 +02:00
Marcus Efraimsson
0ecc24d1c0
Docs: Contribution guideline for merging pull requests (#38800)
Co-authored-by: Hugo Häggmark <hugo.haggmark@grafana.com>
2021-09-06 17:13:13 +02:00
Uchechukwu Obasi
774f0a0d01
e2e guide: improves data-testid code snippet to be clear and understandable (#38791) 2021-09-06 07:03:02 +01:00
Jack Westbrook
8d3b31ff23
Build: Upgrade Webpack 5 (#36444)
* build(webpack): bump to v5 and successful yarn start compilation

* build(webpack): update postcss dependencies

* build(webpack): silence warnings about hash renamed to fullhash

* build(webpack): enable persistent cache to store generated webpack modules / chunks

* build(webpack): prefer eslintWebpackPlugin over tschecker so eslint doesn't block typechecking

* chore(yarn): run yarn-deduplicate to clean up dependencies

* chore(yarn): refresh lock file after clean install

* build(webpack): prefer output.clean over CleanWebpackPlugin

* build(webpack): prefer esbuild over babel-loader for dev config

* build(babel): turn off cache compression to improve build performance

* build(webpack): get production builds working

* build(webpack): remove phantomJS (removed from grafana in v7) specific loader

* build(webpack): put back babel for dev builds no performance gain in using esbuild in webpack

* build(webpack): prefer terser and optimise css plugins for prod. slower but smaller bundles

* build(webpack): clean up redundant code. inform postcss about node_modules

* build(webpack): remove deprecation warnings flag

* build(webpack): bump packages, dev performance optimisations, attempt to get hot working

* chore(storybook): use webpack 5 for dev and production builds

* build(storybook): speed up dev build

* chore(yarn): refresh lock file

* chore(webpack): bump webpack and related deps to latest

* refactor(webpack): put back inline-source-map, move start scripts out of grafana toolkit

* feat(webpack): prefer react-refresh over react-hot-loader

* build(webpack): update webpack.hot to use react-refresh

* chore: remove react-hot-loader from codebase

* refactor(queryeditorrow): fix circular dependency causing react-fast-refresh errors

* revert(webpack): remove stats.errorDetails from common config

* build(webpack): bump to v5 and successful yarn start compilation

* build(webpack): update postcss dependencies

* build(webpack): silence warnings about hash renamed to fullhash

* build(webpack): enable persistent cache to store generated webpack modules / chunks

* build(webpack): prefer eslintWebpackPlugin over tschecker so eslint doesn't block typechecking

* chore(yarn): run yarn-deduplicate to clean up dependencies

* chore(yarn): refresh lock file after clean install

* build(webpack): prefer output.clean over CleanWebpackPlugin

* build(webpack): prefer esbuild over babel-loader for dev config

* build(babel): turn off cache compression to improve build performance

* build(webpack): get production builds working

* build(webpack): remove phantomJS (removed from grafana in v7) specific loader

* build(webpack): put back babel for dev builds no performance gain in using esbuild in webpack

* build(webpack): prefer terser and optimise css plugins for prod. slower but smaller bundles

* build(webpack): clean up redundant code. inform postcss about node_modules

* build(webpack): remove deprecation warnings flag

* build(webpack): bump packages, dev performance optimisations, attempt to get hot working

* chore(storybook): use webpack 5 for dev and production builds

* build(storybook): speed up dev build

* chore(yarn): refresh lock file

* chore(webpack): bump webpack and related deps to latest

* refactor(webpack): put back inline-source-map, move start scripts out of grafana toolkit

* feat(webpack): prefer react-refresh over react-hot-loader

* build(webpack): update webpack.hot to use react-refresh

* chore: remove react-hot-loader from codebase

* refactor(queryeditorrow): fix circular dependency causing react-fast-refresh errors

* revert(webpack): remove stats.errorDetails from common config

* revert(webpack): remove include from babel-loader so symlinks (enterprise) work as before

* refactor(webpack): fix deprecation warnings in prod builds

* fix(storybook): fix failing builds due to replacing css-optimise webpack plugin

* fix(storybook): use raw-loader for svg icons

* build(webpack): fix dev script colors error

* chore(webpack): bump css-loader and react-refresh-webpack-plugin to latest versions

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
2021-08-31 12:55:05 +02:00
Gábor Farkas
8e88600c04
style-guide: frontend: describe directory naming style (#38607)
* style-guide: frontend: describe directory naming style

* apply recommended changes

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-08-27 08:27:56 +02:00