Commit Graph

212 Commits

Author SHA1 Message Date
Sven Grossmann
3335d46c5f
Theme: Fix wrong code segment in theme.md (#62488)
* fix wrong markdown

* fix prettier
2023-03-28 12:18:50 +01:00
Levente Balogh
1c6357637d
FE Style Guide: Update component definition (#64869)
* chore: update our FE styleguide related to React.FC

* fix: typo
2023-03-16 09:57:29 +01:00
Ryan McKinley
4f13e78d11
Chore: Avoid explicit React.FC<Props> when possible (round 2) (#64749) 2023-03-15 16:56:09 +02:00
Ryan McKinley
d710507bc5
Chore: Avoid explicit React.FC<Props> when possible (#64722) 2023-03-14 16:38:21 +02:00
Sofia Papagiannaki
89569be3a6
SQLStore: Fix wrong usage of xorm's insert functions in tests (#63850)
* SQLStore: Fix InsertId

* Prefs: Fix Insert return value

* Fix tests

* Add guidelines
2023-03-02 13:01:36 +02:00
Sofia Papagiannaki
8aae7be4e5
API: Enable serving Swagger UI by default and add docs and guidelines (#63489)
* Enable serving Swagger UI by default

It used to be served behind the `swaggerUi` feature toggle.

* Remove `swaggerUi` feature toggle

* Add docs and guidelines for updating swagger

* Apply suggestions from code review

Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
2023-03-01 16:36:37 +02:00
Josh Hunt
09e523eef2
Update internationalization.md (#63668) 2023-02-24 11:52:23 +00:00
Emil Tullstedt
4fd7743b81
Docs: Update backend contribution guidelines (#63034) 2023-02-07 15:44:56 +01:00
Jo
f6d856f082
SupportBundles: Add support bundle documentation (#61855)
* add support bundle page

* Update docs/sources/troubleshooting/support-bundles/index.md

* Update docs/sources/troubleshooting/support-bundles/index.md

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>

* copy edit

* Update docs/sources/troubleshooting/support-bundles/index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2023-02-07 04:39:47 -05:00
Ashley Harrison
64352e8d08
Chore: Move to node 18 again (#62079)
move to node 18 again
2023-01-26 10:19:39 +00:00
Emil Tullstedt
649b50055c
Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
Dimitris Sotirakis
27bd50da52
Docs: Update merge-pull-request.md regarding backport policies (#59239)
* Update merge-pull-request.md

* yarn run prettier:write
2022-11-23 20:51:09 +02:00
Ashley Harrison
ff1afbb699
Revert "Chore: move to node 18 (#58570)" (#58754)
This reverts commit 0a9129cf90.
2022-11-15 13:47:14 +00:00
Ashley Harrison
0a9129cf90
Chore: move to node 18 (#58570)
* bump node version to 18

* update folder to 18.x

* update README for m1 instructions

* update drone

* update unit test

* update README
2022-11-11 11:34:00 +00:00
Dan Cech
9ea6a43089
Build: clean up and document integration test convention (#58170)
* clean up and document integration test convention

* clarify integration test conventions

* clean up integration tests that don't follow convention

* mark testIntegration* functions as helpers to avoid confusion
2022-11-04 10:14:21 -04:00
Laura Fernández
813ebf988d
Internationalization: Translate TimePickerTitle component (#57909) 2022-11-03 16:03:28 +01:00
Christopher Moyer
088a4e02e8
Docs: removes writing guidelines, points contributors to Writers' Toolkit (#58011)
* removes writing guidelines, points contributors to the Writers' Toolkit

* Update contribute/documentation/README.md

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>

Co-authored-by: Ursula Kallio <ursula.kallio@grafana.com>
2022-11-01 14:48:52 -05:00
Sofia Papagiannaki
40a59c2793
Chore: Update developer guide for running integration tests (#57758) 2022-10-27 17:18:20 +03:00
Emil Tullstedt
2c9526fdf7
Docs: Update errors documentation (#57402)
Expand on what a base should represent and update some out of date info.
2022-10-21 20:50:29 +02:00
Josh Hunt
fc75076b72
I18n: Show languages in local names (#57367)
* I18n: Show languages in local names

* fixed test
2022-10-21 05:29:03 -04:00
Kristin Laemmert
05709ce411
chore: remove sqlstore & mockstore dependencies from (most) packages (#57087)
* chore: add alias for InitTestDB and Session

Adds an alias for the sqlstore InitTestDB and Session, and updates tests using these to reduce dependencies on the sqlstore.Store.

* next pass of removing sqlstore imports
* last little bit
* remove mockstore where possible
2022-10-19 09:02:15 -04:00
Josh Hunt
8e512de308
I18n: update contributing docs (#56860)
* update contrib i18n docs

* update contrib i18n docs

* remove lingui references, rearrage plain js usage
2022-10-14 11:55:15 +01:00
Josh Hunt
719769ee7c
I18n: Add Chinese (Simplified) (#56739)
* Prevent _old.json files from being created

* Add contrib docs for adding new locale

* add chinese (simplified)
2022-10-12 06:12:46 -04:00
Torkel Ödegaard
580ca144fd
StyleGuide: Minor fix for themes.md (#56012)
* Update themes.md

* Update themes.md

* Updates
2022-10-05 08:50:39 +02:00
George Rodrigues
8950d86141
fix: some typos (#56171) 2022-10-04 18:43:49 -05:00
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