Onboarding issues I noticed (#105211)

* Fix inconsistency in command instructions between the Backend and Frontend section.

* Increase ulimit advice.

On a bare system I'm getting almost 6200 files from the given `find` command.
It's clear that this project has grown considerably since this line was added
to the onboarding docs.

* starting grafana is not explained in the devenv readme.
This commit is contained in:
Jason Marshall
2025-10-24 14:54:30 +02:00
committed by GitHub
parent 5ee636d47d
commit 83ec5e6789
2 changed files with 11 additions and 4 deletions
+8 -2
View File
@@ -134,7 +134,13 @@ Next, we'll explain how to build and run the web server that serves these fronte
### Backend
Build and run the backend by running `make run` in the root directory of the repository. This command compiles the Go source code and starts a web server.
Build and run the backend by running
```
make run
```
in the root directory of the repository. This command compiles the Go source code and starts a web server.
> **Troubleshooting:** Are you having problems with [too many open files](#troubleshooting)?
@@ -312,7 +318,7 @@ ulimit -a
To change the number of open files allowed, run:
```
ulimit -S -n 4096
ulimit -S -n 8000
```
The number of files needed may be different on your environment. To determine the number of open files needed by `make run`, run:
+3 -2
View File
@@ -25,8 +25,9 @@ To remove the setup developer dashboards and data sources
./setup.sh undev
```
After restarting the Grafana server, there should be a number of data sources named `gdev-<type>` provisioned as well as
a dashboard folder named `gdev dashboards`. This folder contains dashboard and panel features tests dashboards.
After restarting the Grafana server (`make run`), there should be a number of data sources named `gdev-<type>`
provisioned as well as a dashboard folder named `gdev dashboards`. This folder contains dashboard and panel features
tests dashboards.
Please update these dashboards or make new ones as new panels and dashboards features are developed or new bugs are
found. The dashboards are located in the `devenv/dev-dashboards` folder.