Add documentation for running the prebuilt UI to the Getting Started guide

[mzenker]

Add a page describing how to run the prebuilt UI on Linux using the nginx web server. Link to that page from the Getting Started Guide. Small edits in the section "Run OpenEMS UI" of the Getting Started Guide.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

Additional details and impacted files

@@              Coverage Diff              @@
##             develop    #3702      +/-   ##
=============================================
+ Coverage      60.16%   60.20%   +0.04%     
  Complexity       106      106              
=============================================
  Files           3234     3235       +1     
  Lines         141962   141999      +37     
  Branches       10446    10453       +7     
=============================================
+ Hits           85404    85483      +79     
+ Misses         53400    53347      -53     
- Partials        3158     3169      +11     

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[da-Kai]

Hi @mzenker,

Thanks! You are right, the "how to deploy the UI"-Step is currently missing.

To keep our documentation consistent across the backend, edge, and ui, we should move this new file to the ui/deploy/ path? Something like ui/deploy/nginx.adoc would fit the existing structure.

[mzenker]

Hi @da-Kai ,
the instructions I wrote are not really intended as instructions on how to deploy the UI, as this would include setting it up as a service and moving the UI files to a system location. I just wanted to describe a quick setup to fit with the instructions for running the prebuilt edge in the Getting Started Guide. So maybe I should rather include the contents of the new file ui/run-prebuilt.adoc directly in gettingstarted.adoc and create a file describing the "real" deployment of the UI as next step.

[da-Kai]

Hi @mzenker

I see your point that this is just a 'quick setup' and not a fully production-ready environment.
However, Setting up nginx to host the UI still falls under 'Deployment' for the end-user.

I would prefer to follow idiomatic design, consistent with most documentation.

Move this to ui/deploy/nginx.adoc and add a clear 'Quick Start' or 'Development Only' disclaimer at the top, noting that it's not intended for production use.
Later, we can add a 'Production' or 'Best Practices' section to that same file.

This keeps the gettingstarted.adoc from becoming a wall of text while ensuring the UI instructions live where people expect to find them.

[mzenker]

Hi @da-Kai,
OK, I would then propose to move the "General" section of run-prebuilt.adoc to the Getting Started Guide and put the section "Set up the nginx webserver on Linux" in ui/deploy/nginx.adoc.

[mzenker]

@da-Kai Done. Are the commits in this branch squashed together anyway when merged, or should I do it in the branch?

[sfeilmeier]

Thank you!