openhab-docs
openhab-docs copied to clipboard
openhab
[WIP] Reworking Rules docs
Getting started implementing #1855.
This first commit has some placeholders for the files we'll need but doesn't include any content changes yet.
Signed-off-by: Richard Koshak [email protected]
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 | c448d72f729779c27717449340a7347c46bca338 |
| Latest deploy log | https://app.netlify.com/sites/openhab-docs-preview/deploys/6378086d205ab30009fa2bbf |
| Deploy Preview | https://deploy-preview-1860--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 settings.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hey @rkoshak,
i know this is a big one and you have many things on your list usually. Is there any chance that we split the changes/to-do's from #1855 and do a partly merge?
From my view any refactored documentation is a win for us, even if it isn't 100% and includes all asked points. :) There are already good improvements here, that are laying around for weeks now.
Is a partly change possible or would that have a negetaive effect for your workigns on this?
We can but even what we have now isn't really ready. If at least like to get the concepts page done before the first merge. Then I think we can treat each page after that as a separate PR. Though if like to continue to track the progress on the same issue if that's ok.
I agree on @rkoshak ‘s opinion. Let’s get the concepts page done, and then have the first merge.
FYI: I continue to work on the concepts page, but I will probably leave some parts out, e.g. the rule templates as this is clearly a thing @rkoshak is far more experienced in.
I read the community thread you linked, a scene rule is definitely something that has to be included in the examples of the concepts page. I am also thinking of saying that it is possible to realise scenes with rules on top of the page.
This pull request has been mentioned on openHAB Community. There might be relevant details there:
https://community.openhab.org/t/scenes-openhab-vs-home-assistant-in-2022/138782/21
Though if like to continue to track the progress on the same issue if that's ok.
Yes of course. :)
@Confectrician FYI: The concepts page should be finished soon, and can then be merged.
Rkoshak reviewed my contribution of the concepts page, so there shouldn‘t be need for a super detailed review from your side, I think there are just some styling issues (e.g. the ToC) where we need your help regarding Jekyll.
~~I think I broke it. ~~
~~I've been trying to fix the premerge checks like linting and such and now it's not running those checks nor is it deploying the preview. I'm not sure what I can do at this point. ~~
Ha! Renaming the PR seems to kicked it off.
@Confectrician , this is ready for review.
None of the other concepts pages have a TOC but I think it's useful to have it for the rules page. Should we be consistent and remove it (or add one to the other pages) or keep it in even if it's inconsistent? Also, is there a way to set the TOC to only show level 2 headings? I don't think we need to go to level 3 and 4 for this page. I tried changing the levels from 2..4 to just 2 but it's still showing them all.
The MD linting errors are not from our changes (and frankly I think they are false positives).
@florian-h05, It seems we cannot have a space in the title for the tabs in our examples. So I renamed the tabs to UI, DSL, JRuby, and JS.
Also, now that I see it, I wonder if later on we ought to replace the JS examples with rule builder. As it is right now, the JS examples look really wordy compared to even Rules DSL. We can leave it as is for this PR though but I think the JS examples will look more comparable using the builder instead of JSRule.
Finally, @Confectrician, the next PR will create a new "Rules" section in the sidebar (similar to the UIs section). Is there anything else I need to modify beyond the .vuepress/config.js file? It seems I remember needing to edit another file too but I can't figure out what.
@Confectrician , this is ready for review.
🎉
None of the other concepts pages have a TOC but I think it's useful to have it for the rules page. Should we be consistent and remove it (or add one to the other pages) or keep it in even if it's inconsistent? Also, is there a way to set the TOC to only show level 2 headings? I don't think we need to go to level 3 and 4 for this page. I tried changing the levels from 2..4 to just 2 but it's still showing them all.
If you refer to the curly braced configuration you can throw it away anyways. This is an old way of configuring the TOC, we used when the docs were served via guthub pages. From what i read we can configure the toc only for the complete website.
The MD linting errors are not from our changes (and frankly I think they are false positives).
They are correct, but i am already working on #1906 and the should be solved then.
I will need some time for review, but would try to get it done over the weekend.