grafana/contribute/backend
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
..
communication.md Docs: Update backend contribution guidelines (#63034) 2023-02-07 15:44:56 +01:00
database.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
errors.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
instrumentation.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
package-hierarchy.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
README.md API: Enable serving Swagger UI by default and add docs and guidelines (#63489) 2023-03-01 16:36:37 +02:00
recommended-practices.md Docs: Update backend contribution guidelines (#63034) 2023-02-07 15:44:56 +01:00
services.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00
style-guide.md Docs: Update backend contribution guidelines (#63034) 2023-02-07 15:44:56 +01:00
support-bundles.md SupportBundles: Add support bundle documentation (#61855) 2023-02-07 04:39:47 -05:00
upgrading-dependencies.md Chore: Move all backend contribution documents to a single directory (#61140) 2023-01-11 11:16:52 +01:00

Backend

First read the backend style guide to get a sense for how we work to ensure that the Grafana codebase is consistent and accessible. The rest of the backend contributor documentation is more relevant to reviewers and contributors looking to make larger changes.

For anyone reviewing code for Grafana's backend, a basic understanding of content of the following files is expected:

Reviewers who review large changes should additionally make a habit out of familiarizing themselves with the content of /contribute/backend from time to time.

Dependency management

Refer to UPGRADING_DEPENDENCIES.md.