Add Main UI docs for integration into sidebar help #2199

florian-h05 · 2024-01-03T13:38:37Z

Required for openhab/openhab-webui#2253.

Please have a look at the CONTRIBUTING.md inside the mainui folder.

netlify · 2024-01-03T13:40:02Z

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

Name	Link
🔨 Latest commit	`b70c874`
🔍 Latest deploy log	https://app.netlify.com/sites/openhab-docs-preview/deploys/65b43c45f3cd7700087cae6a
😎 Deploy Preview	https://deploy-preview-2199--openhab-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

florian-h05 · 2024-01-03T13:40:35Z

I have now migrated all content that was hard-coded into the UI to the docs repo and created the structure for the new Main UI docs. You can run my linked UI PR locally to see how the UI integrates the docs.

Feel free to extend the documentation, migrate docs from elsewhere in this repo and put some content into the empty files.

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

stefan-hoehn

@florian-h05 This is an amazing contribution to the docs and you earn the docs gold medal for the month 🥇 🤩

Given the amount of text you contributed I only found only a few minor issues.

stefan-hoehn · 2024-01-26T19:48:49Z

mainui/CONTRIBUTING.md

+Inside these comments, the UI allows the following features:
+
+- Embed [Framework7 icons](https://framework7.io/icons/) into the UI-rendered docs using these comments:
+  - `<!--F7 $iconame -->`, where `$iconname` is a Framework7 icon's name


where $iconame (one n too much)

It is one n missing in $iconame ;-)

stefan-hoehn · 2024-01-26T19:56:38Z

mainui/about.md

+- Logs folder on the server
+- Operating System openHAB is running on
+- Java Runtime openHAB is running on
+- number of processors and memory


stefan-hoehn · 2024-01-26T19:58:59Z

mainui/about.md

+Main UI implements a web audio sink which allows the openHAB server to play audio through the web browser.
+
+To enable web audio sink support for a client, turn on the **Enable Web Audio sink support** option on the **Help & About** page.
+As it is setting specific to your browser environment, web audio support has to be enabled for every client where it should be used.


setting-specific

stefan-hoehn · 2024-01-26T20:00:09Z

mainui/about.md

+As it is setting specific to your browser environment, web audio support has to be enabled for every client where it should be used.
+
+Please note that due to limitations in Safari (and possibly Chrome as well), a user interaction is required after the first audio stream has been sent to actually play it.
+This means, that after opening Main UI, the first audio that should be played on the web audio sink is only player after the user interacts with Main UI in any way (i.e. touching the screen is enough).


only played

stefan-hoehn · 2024-01-26T20:01:57Z

mainui/about.md

+
+Please note that due to limitations in Safari (and possibly Chrome as well), a user interaction is required after the first audio stream has been sent to actually play it.
+This means, that after opening Main UI, the first audio that should be played on the web audio sink is only player after the user interacts with Main UI in any way (i.e. touching the screen is enough).
+For subsequent audio playback, that is not required anymore and the audio is played immediately.


For subsequent audio playback the above is not required anymore and the audio is played immediately.

stefan-hoehn · 2024-01-26T21:06:11Z

mainui/settings/schedule.md

+
+![saturday-morning-rule](../images/saturday-rule-schedule.png)
+
+A rule that is schedule repeatedly like everyday at 8:00 in the morning will therefore be shown on every day of the calendar view.


A rule that is scheduled repeatedly

stefan-hoehn · 2024-01-26T21:09:09Z

mainui/settings/scripts.md

+<!-- START MAINUI SIDEBAR DOC - DO NOT REMOVE -->
+**Rules** are the heart of home automation.
+**Scripts** are special types of rules with only one action and no triggers, so they have to be called from "real" rules or run manually.
+They can be used to reuse code and logic across multiple other rules, one off experimentation to figure something out, create a catalog of examples, or to drive tests for other rules and behaviors.


for experimentation to figure

stefan-hoehn · 2024-01-26T21:13:49Z

mainui/settings/things.md

+- **Add new Things**<br>
+  Use the [Thing Inbox](#inbox) to scan for available things or manually add ones that cannot be found automatically using the <!--F7:blue plus_circle_fill --> plus button.
+- **Configure Things**<br>
+  Click on any Thing in the list to see its configuration page and it's channels.


its channels.

stefan-hoehn · 2024-01-26T21:15:27Z

mainui/settings/things.md

+It therefore makes a lot of sense to use these features for a smart home solution.
+
+openHAB bindings can therefore implement Discovery Services for Things, which provide Discovery Results.
+All Discovery Results are put into the Thing inbox, from where they can be easily added to openHAB with just a few clicks.


Thing inbox from where they can be

stefan-hoehn · 2024-01-26T21:16:05Z

mainui/settings/transformations.md

+# Settings - Transformations
+
+<!-- START MAINUI SIDEBAR DOC - DO NOT REMOVE -->
+**Transformations** convert a value or Item state into different value or state.


into a different value

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 · 2024-01-26T23:15:49Z

@stefan-hoehn Thank you for your fast review of this big PR!! I have addressed your review.

This is an amazing contribution to the docs and you earn the docs gold medal for the month 🥇 🤩

Thank you very much, I guess I will share it with you since you wrote large parts of the docs that I moved around, and with @JustinGeorgi, who originally wrote what has been added to the UI and what I migrated to the docs repo.

stefan-hoehn

Thanks, looks good now.

) Follow-up for #2088. Depends on openhab/openhab-docs#2199. Also add the help sidebar button to the settings and list pages where it is missing. --------- Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 · 2024-02-02T09:09:11Z

@ghys @Confectrician Why can’t I find that documentation changes on https://next.openhab.org/docs?

stefan-hoehn · 2024-02-05T18:35:58Z

@kaikreuzer Do you mind having a look. It is actually weird that we don't see the changes. I also don't see a way to trigger a new build. Do you know what happened here?

An example would be https://next.openhab.org/docs/mainui/about.html which is missing.

ghys · 2024-02-06T15:30:45Z

The website fails to build on Netlify since Jan 26th:
https://app.netlify.com/sites/openhab-next/deploys/65c1516267c7c40008971007
with this error:

10:22:45 PM: /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1225:in `stat": No such file or directory @ rb_file_s_stat - .vuepress/openhab-docs/settings/images (Errno::ENOENT)
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1225:in `lstat"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1254:in `copy"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:416:in `block in copy_entry"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1388:in `wrap_traverse"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:413:in `copy_entry"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:391:in `block in cp_r"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1461:in `block in fu_each_src_dest"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1477:in `fu_each_src_dest0"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:1459:in `fu_each_src_dest"
	from /opt/buildhome/.rvm/rubies/ruby-2.4.3/lib/ruby/2.4.0/fileutils.rb:390:in `cp_r"
	from prepare-docs.rb:359:in `<main>"

corresponding to this line in prepare-docs.rb:
https://github.com/openhab/website/blob/31c746e62fa4c3d5a3fc33c070713acfd2dd308c/prepare-docs.rb#L359

openhab/openhab-docs#2199 broke the website build due to the directory structure changes. This adjusts the build script and therefore fixes the website build. Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 · 2024-02-06T18:46:25Z

openhab/website#445 will fix the website build.

* Adjust to openhab/openhab-docs#2199 openhab/openhab-docs#2199 broke the website build due to the directory structure changes. This adjusts the build script and therefore fixes the website build. Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 mentioned this pull request Jan 3, 2024

Help sidebar: Move docs to docs repo & Integrate them into the UI openhab/openhab-webui#2253

Merged

florian-h05 added 4 commits January 17, 2024 22:49

Add Main UI docs structure & Migrate UI-integrated docs

484f849

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

Add some links

e1dc2ed

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

Add CONTRIBUTING.md

3271e3c

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

Update icon comments for UI code change

921112f

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from ced2e65 to 921112f Compare January 17, 2024 21:50

Fix markdownlint

9ae7489

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 80e88c3 to 9ae7489 Compare January 17, 2024 21:56

Migrate existing MainUI settings documentation

e5ad108

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch 4 times, most recently from 2cef667 to ae20c8b Compare January 26, 2024 09:23

Fix build & Update sidebar

120fd37

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 73f1cd0 to 120fd37 Compare January 26, 2024 09:34

Update img links

f97fd9a

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch 5 times, most recently from 53de863 to 2f60e90 Compare January 26, 2024 13:47

Migrate docs from the UI section

e7676a6

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 2f60e90 to e7676a6 Compare January 26, 2024 13:49

Add persistence docs

8929fc0

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 4f45e36 to 76eaabe Compare January 26, 2024 14:53

Fixes & Improvements

7aecd66

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 76eaabe to 7aecd66 Compare January 26, 2024 15:25

florian-h05 marked this pull request as ready for review January 26, 2024 15:27

Update CONTRIBUTING.md

ab92bbd

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 force-pushed the mainui-doc-integration branch from 30f11f2 to ab92bbd Compare January 26, 2024 15:40

stefan-hoehn requested changes Jan 26, 2024

View reviewed changes

Address review

b70c874

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

stefan-hoehn approved these changes Jan 26, 2024

View reviewed changes

stefan-hoehn added this to the 4.2 milestone Jan 26, 2024

stefan-hoehn merged commit 321c8de into openhab:main Jan 26, 2024
5 checks passed

florian-h05 deleted the mainui-doc-integration branch January 26, 2024 23:38

florian-h05 mentioned this pull request Feb 6, 2024

Adjust to https://github.com/openhab/openhab-docs/pull/2199 openhab/website#445

Merged

florian-h05 mentioned this pull request Feb 7, 2024

Script editor: Add commenting/uncommenting with Ctrl-/ and Cmd-/ openhab/openhab-webui#2322

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Main UI docs for integration into sidebar help #2199

Add Main UI docs for integration into sidebar help #2199

florian-h05 commented Jan 3, 2024 •

edited

Loading

netlify bot commented Jan 3, 2024 •

edited

Loading

florian-h05 commented Jan 3, 2024

stefan-hoehn left a comment

stefan-hoehn Jan 26, 2024

florian-h05 Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

stefan-hoehn Jan 26, 2024

florian-h05 commented Jan 26, 2024

stefan-hoehn left a comment

florian-h05 commented Feb 2, 2024

stefan-hoehn commented Feb 5, 2024

ghys commented Feb 6, 2024

florian-h05 commented Feb 6, 2024


		![saturday-morning-rule](../images/saturday-rule-schedule.png)

		A rule that is schedule repeatedly like everyday at 8:00 in the morning will therefore be shown on every day of the calendar view.

Add Main UI docs for integration into sidebar help #2199

Add Main UI docs for integration into sidebar help #2199

Conversation

florian-h05 commented Jan 3, 2024 • edited Loading

netlify bot commented Jan 3, 2024 • edited Loading

✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).

florian-h05 commented Jan 3, 2024

stefan-hoehn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

florian-h05 commented Jan 26, 2024

stefan-hoehn left a comment

Choose a reason for hiding this comment

florian-h05 commented Feb 2, 2024

stefan-hoehn commented Feb 5, 2024

ghys commented Feb 6, 2024

florian-h05 commented Feb 6, 2024

florian-h05 commented Jan 3, 2024 •

edited

Loading

netlify bot commented Jan 3, 2024 •

edited

Loading