Skip to content

Fix: updated Docker deployment docs (issue #3411)#3412

Merged
sfeilmeier merged 6 commits intoOpenEMS:developfrom
akshith30388:fix-docs-3411
Nov 26, 2025
Merged

Fix: updated Docker deployment docs (issue #3411)#3412
sfeilmeier merged 6 commits intoOpenEMS:developfrom
akshith30388:fix-docs-3411

Conversation

@akshith30388
Copy link
Copy Markdown
Contributor

This PR updates the Docker deployment documentation to:

  • Replace deprecated UI_WEBSOCKET with WEBSOCKET_HOST and WEBSOCKET_PORT
  • Add a “Changing Language in UI” section
  • Add a “Next Steps” section for clarity

Fixes: #3411

…I_WEBSOCKET, added language and next steps sections
@akshith30388
Copy link
Copy Markdown
Contributor Author

Hi @daandupau @rnicolas
I’ve updated the Docker deployment docs as per Issue #3411 — replacing UI_WEBSOCKET with WEBSOCKET_HOST and WEBSOCKET_PORT, and adding the language and next steps sections.
Please review when you get a chance. Thank you!

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop    #3412      +/-   ##
=============================================
+ Coverage      59.61%   59.63%   +0.02%     
  Complexity       112      112              
=============================================
  Files           2894     2894              
  Lines         124658   124658              
  Branches        9343     9343              
=============================================
+ Hits           74304    74323      +19     
+ Misses         47534    47524      -10     
+ Partials        2820     2811       -9     
🚀 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
Copy link
Copy Markdown
Contributor

da-Kai commented Nov 14, 2025

@akshith30388 thanks,
looks good to me, i like the "Next Steps"-section. Your changes to docker docs overlap a bit with my PR #3391

@akshith30388
Copy link
Copy Markdown
Contributor Author

@akshith30388 thanks, looks good to me, i like the "Next Steps"-section. Your changes to docker docs overlap a bit with my PR #3391
Hi @da-Kai,
Thanks for the feedback! Since there is some overlap with PR #3391,
please let me know if you’d like me to update my changes to avoid conflicts,
or if I should wait for your PR to merge first.

I’m happy to adjust anything needed. Thanks!

da-Kai

This comment was marked as resolved.

@akshith30388
Copy link
Copy Markdown
Contributor Author

Hi @da-Kai — thanks for spotting that!

The change that removed the leading = from the document title was unintended (it affects the AsciiDoc heading). I’ve reverted that single line so the title is back to:

= Deploy OpenEMS Edge to Docker

All your other suggestions have been applied and the file has been updated to resolve the conflicts. Could you please re-check and approve the workflow when you have a moment? Thanks a lot for the review and the guidance.

@akshith30388
Copy link
Copy Markdown
Contributor Author

akshith30388 commented Nov 18, 2025 via email


== Changing the Language in the UI

To change the language in the OpenEMS UI, open the UI in your browser, click on the settings (⚙️) icon in the top-right corner, and select your preferred language.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@akshith30388
I don't know how i missed that, in the previous reviews 😅. I like the idea, but the steps described are wrong. There ist no settings (⚙️) icon in the top-right corner

Could you update the instructions to reflect the actual steps to change the UI language?

Copy link
Copy Markdown
Collaborator

@Sn0w3y Sn0w3y Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to point this out - some AI is hallucinating on this here 😂

@akshith30388
Copy link
Copy Markdown
Contributor Author

Hi @da-Kai,

Thanks for pointing this out! The settings (⚙️) icon reference was incorrect.
I’ve now updated the “Changing the Language in the UI” section to reflect the actual steps:

Language selection is available through the user/profile (avatar) menu

Users can choose their preferred language directly from the dropdown

The instructions have been corrected accordingly.

Copy link
Copy Markdown
Contributor

@da-Kai da-Kai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know LLMs can be helpful, but unfortunately they don’t know the OpenEMS UI 😜

To change the language in the OpenEMS UI:

1. Open the OpenEMS Edge UI in your browser.
2. Click the user/profile icon (avatar) in the top-right corner of the UI.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its the top-left corner.


1. Open the OpenEMS Edge UI in your browser.
2. Click the user/profile icon (avatar) in the top-right corner of the UI.
3. Choose your preferred language from the "Language" dropdown in the profile menu.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dropdown is called "Sprache wählen:" (default) or "Select language:" in english

1. Open the OpenEMS Edge UI in your browser.
2. Click the user/profile icon (avatar) in the top-right corner of the UI.
3. Choose your preferred language from the "Language" dropdown in the profile menu.
4. The UI will immediately switch to the selected language (or you may need to reload).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently a reload will actually reset the language. My PR #3415 would fix this.

3. Choose your preferred language from the "Language" dropdown in the profile menu.
4. The UI will immediately switch to the selected language (or you may need to reload).

If helpful, you can add a small screenshot showing the profile menu and language dropdown for clarity.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

@akshith30388
Copy link
Copy Markdown
Contributor Author

Hi @da-Kai, thanks for the clarifications!

I’ve updated the section based on your feedback:

  • Corrected the avatar icon position to top-left
  • Updated the dropdown label to “Sprache wählen:” / “Select language:”
  • Removed the reload note, since the language resets on reload (as you mentioned)
  • Cleaned up the steps to reflect the actual UI behaviour

Please let me know if anything else should be adjusted. Thanks again for your detailed review!

@Sn0w3y
Copy link
Copy Markdown
Collaborator

Sn0w3y commented Nov 18, 2025

I know LLMs can be helpful, but unfortunately they don’t know the OpenEMS UI 😜

Also right now we are currently seeing PRs with MANY unnecessary changes due to LLMs - but this is probably worth a Discussion on community.openems.io

@da-Kai
Copy link
Copy Markdown
Contributor

da-Kai commented Nov 18, 2025

Hi @da-Kai,

Thanks for pointing this out! The settings (⚙️) icon reference was incorrect. I’ve now updated the “Changing the Language in the UI” section to reflect the actual steps:

Language selection is available through the user/profile (avatar) menu

Users can choose their preferred language directly from the dropdown

The instructions have been corrected accordingly.

Hi @akshith30388,

it looks like something might have gone wrong with your last commit, as i see no changes.

@da-Kai da-Kai requested a review from sfeilmeier November 26, 2025 08:27
@sfeilmeier sfeilmeier merged commit 051bffd into OpenEMS:develop Nov 26, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs are really unclear

4 participants