Skip to content

Rules DSL: Document new commands#2728

Merged
florian-h05 merged 13 commits into
openhab:mainfrom
Nadahar:dsl-extras
Jul 2, 2026
Merged

Rules DSL: Document new commands#2728
florian-h05 merged 13 commits into
openhab:mainfrom
Nadahar:dsl-extras

Conversation

@Nadahar

@Nadahar Nadahar commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

This documents the changes that were introduced in openhab/openhab-core#5481.

@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

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).

Built without sensitive environment variables

Name Link
🔨 Latest commit 888bc6b
🔍 Latest deploy log https://app.netlify.com/projects/openhab-docs-preview/deploys/6a46c27674992d000836a841
😎 Deploy Preview https://deploy-preview-2728--openhab-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@Nadahar Nadahar force-pushed the dsl-extras branch 6 times, most recently from 979f8d4 to b6e30c8 Compare June 12, 2026 03:14
@rkoshak

rkoshak commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

It's certainly not ideal, but when you submit the PR netlify will deploy a preview you can use to see how the changes are rendered.

@Nadahar

Nadahar commented Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

It's certainly not ideal, but when you submit the PR netlify will deploy a preview you can use to see how the changes are rendered.

It's what I've been doing here. I make changes, push and wait for the preview. But, it's a slow process.

I've added more details on the sidebar menu in this preview. Check it out, what do you think? I think it can be hard to find the right section in longer pages.

@Nadahar

Nadahar commented Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

I guess this is ready for review. Please note the first commit that modifies the number of levels on the sidebar menu. I think it's much better with a more detailed menu, but it should be evaluated by others.

All that is here is already in 5.2.0, so ideally this documentation should be a part of the 5.2.0 documentation as well.

@Nadahar Nadahar marked this pull request as ready for review June 27, 2026 05:06
@Nadahar

Nadahar commented Jun 27, 2026

Copy link
Copy Markdown
Contributor Author

I don't know who reviews such documentation, my guess is that not too many people are in a position to point of what of this is wrong, if anything.

I'm not in love with using a table to present the methods, it feels a bit "messy", but I couldn't quite find another way that wouldn't make the section much more laborious and loong.

@rkoshak Are you by any chance capable of doing at least a "coarse review" of this?

@Nadahar

Nadahar commented Jun 28, 2026

Copy link
Copy Markdown
Contributor Author

@florian-h05 What must I do to get this looked at? It would be a shame if this didn't make it into 5.2.0, since the functionality is there in 5.2.0.

@rkoshak rkoshak left a comment

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.

Not a lot to comment on. I worry about the long term maintenance impact of listing the methods of each class but the Extensions need to be documented here anyway so it probably doesn't save much.

Comment thread configuration/rules-dsl.md Outdated
Ravi Nadahar added 7 commits July 2, 2026 16:27
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Ravi Nadahar added 4 commits July 2, 2026 16:27
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
@Nadahar

Nadahar commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

@florian-h05 What do I have to do to get this looked at/reviewed?

@florian-h05

Copy link
Copy Markdown
Contributor

I'll have a look at it. It's really a pain that the doc maintainers all seem to be unavailable for months now. I am just looking through the PRs and reviewing and merging stuff ...

@Nadahar

Nadahar commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

I'll have a look at it. It's really a pain that the doc maintainers all seem to be unavailable for months now. I am just looking through the PRs and reviewing and merging stuff ...

Yeah, that's really hopeless, especially around a release.

Please note the change I've done to the side menu in this PR. It makes it much more detailed. Some may find it better and others worse, but I think it makes it much easier to find the section you're after.

@Nadahar

Nadahar commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Do I understand it correct that you are the only one with "merge privileges" that actually "maintain" the docs at this time? Are there nobody else that can help?

@florian-h05 florian-h05 left a comment

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.

Overall LGTM, only these two comments:

Comment thread .vuepress/config.ts
Comment thread configuration/rules-dsl.md Outdated
@florian-h05

Copy link
Copy Markdown
Contributor

Do I understand it correct that you are the only one with "merge privileges" that actually "maintain" the docs at this time?

Yes.

Are there nobody else that can help?

The docs maintainers are unavailable, and Kai is more or less in the same position as me and active across several repos. Probably the time to propose a new model for maintaining the docs ...

@Nadahar

Nadahar commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

I've created #2739 for the sidebar depth.

Ravi Nadahar added 2 commits July 2, 2026 21:56
This reverts commit 2a36264.

Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
Signed-off-by: Ravi Nadahar <nadahar@rediffmail.com>
@florian-h05 florian-h05 added this to the 5.2 milestone Jul 2, 2026
@florian-h05 florian-h05 changed the title Document new DSL commands Rules DSL: Document new commands Jul 2, 2026
@florian-h05 florian-h05 merged commit 7678d7c into openhab:main Jul 2, 2026
5 checks passed
@Nadahar Nadahar deleted the dsl-extras branch July 2, 2026 21:25
Comment thread configuration/rules-dsl.md
@dilyanpalauzov

Copy link
Copy Markdown
Contributor

Probably the time to propose a new model for maintaining the docs ...

I propose: if in 66 days there are no objections, the proposed change is integrated.

It can happen that an objection would be that in the future something will change (in core, webui), and afterwards somebody could write documentation that the same operation can be achieved in a neater way. If within the 66 days nobody proposes documentation how to achieve the same in a neater way, then the original proposal is accepted.

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.

4 participants