From 83ec5e6789a28547692a211c12c04b88db30b207 Mon Sep 17 00:00:00 2001 From: Jason Marshall Date: Fri, 24 Oct 2025 05:54:30 -0700 Subject: [PATCH] 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. --- contribute/developer-guide.md | 10 ++++++++-- devenv/README.md | 5 +++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/contribute/developer-guide.md b/contribute/developer-guide.md index c5a00edd042..eaa8334926c 100644 --- a/contribute/developer-guide.md +++ b/contribute/developer-guide.md @@ -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: diff --git a/devenv/README.md b/devenv/README.md index 72c218037b9..eda3d58d13f 100644 --- a/devenv/README.md +++ b/devenv/README.md @@ -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-` 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-` +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.