Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Multiple binding markdown fixes #17422

Merged
merged 12 commits into from
Sep 28, 2024
Merged

Multiple binding markdown fixes #17422

merged 12 commits into from
Sep 28, 2024

Conversation

lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Sep 15, 2024 •
edited
Loading

  • Fixes some SAT warnings about markdown.
  • Reformatted some tables. (no change to content, just whitespaces)
  • Fixes some icons missing in the docs folder cuasing 404's.
  • Fixes some duplicate headers in the docs, causing anchor tags to fail.
  • Adjusted all lists to dashes
  • Removed all trailing whitespaces
  • Added ini language to some configuraiton related code fences

@lsiepel
Fixes docs
131a38d 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel
Removed excess icons
c1f70ad 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
lolodomo
lolodomo reviewed Sep 16, 2024
View reviewed changes
bundles/org.openhab.binding.warmup/README.md Outdated Show resolved Hide resolved
bundles/org.openhab.io.homekit/README.md Outdated Show resolved Hide resolved
bundles/org.openhab.io.openhabcloud/README.md Outdated Show resolved Hide resolved
@lsiepel
Review comment
90ac2d9 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel lsiepel requested a review from lolodomo September 18, 2024 18:27
@holgerfriedrich
Copy link
Member

Overall, LGTM, thanks for caring!

I share the doubts with perl code formatting, but I have not checked the rendering. Maybe not a problem at all - though we typically use java formatting, right?

The question is if we should change meteoalerte (as my impression is that it should be replaced by metrofrance, correct me if I am wrong).

@lsiepel
Copy link
Contributor Author

lsiepel commented Sep 21, 2024 •
edited
Loading

Overall, LGTM, thanks for caring!

I share the doubts with perl code formatting, but I have not checked the rendering. Maybe not a problem at all - though we typically use java formatting, right?

I can revert those perl changes and maybe @wborn can add anything to it as he previously created the base in the linked post for these languages. As Java uses a different comment tag I would opt not to use that case fence language.

The question is if we should change meteoalerte (as my impression is that it should be replaced by metrofrance, correct me if I am wrong).

I’ll revert changes to that one as we are about to finish the change from meteoalerte to meteofrance with @clinique

@holgerfriedrich this is the difference between perl and java for these blocks:
image

@lsiepel
Revert meteoalerte
8eb97f7 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel
Revert perl code fences
8cd2958 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel
Revert another perl block
a550602 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@lsiepel
Copy link
Contributor Author

lsiepel commented Sep 21, 2024

Reverted the perl blocks as these are doubts and reverted meteoalerte.
Please merge to prevent conflicts as it touches multiple bindings.

@lsiepel
Copy link
Contributor Author

lsiepel commented Sep 22, 2024

Build fail is not related @lolodomo

@lsiepel
Copy link
Contributor Author

lsiepel commented Sep 27, 2024

@openhab/add-ons-maintainers I prefer not to go though conflict resolving so if you have some time, please merge.

@lsiepel
Review comments
310fbdb 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
morph166955
morph166955 approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@morph166955 morph166955 left a comment

Choose a reason for hiding this comment

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

LGTM AndroidTV and Neeo

@lsiepel
Copy link
Contributor Author

lsiepel commented Sep 28, 2024

Last commit is about removing trailing spaces using the regex "\s+$" 1189 occurences are fixed. I checked 15-20% and could not finde any reason why these whitespaces should be left in.

@lsiepel
Fix conflicts
a66944a 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
andrewfg
andrewfg approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@andrewfg andrewfg left a comment

Choose a reason for hiding this comment

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

LGTM growatt
LGTM hue
LGTM neohub

florian-h05
florian-h05 approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@florian-h05 florian-h05 left a comment

Choose a reason for hiding this comment

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

LGTM evcc

stefan-hoehn
stefan-hoehn approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@stefan-hoehn stefan-hoehn left a comment

Choose a reason for hiding this comment

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

Nanoleaf and Govee look good to me

mlobstein
mlobstein approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@mlobstein mlobstein left a comment

Choose a reason for hiding this comment

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

LGTM

jlaur
jlaur approved these changes Sep 28, 2024
View reviewed changes
Copy link
Contributor

@jlaur jlaur left a comment

Choose a reason for hiding this comment

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

LGTM. Many thanks for the major cleanup.

@jlaur jlaur merged commit 1a42353 into openhab:main Sep 28, 2024
4 of 5 checks passed
@jlaur jlaur added this to the 4.3 milestone Sep 28, 2024
@lsiepel lsiepel deleted the documentation-fixes branch September 28, 2024 16:09
druciak
druciak reviewed Sep 28, 2024
View reviewed changes
Copy link
Member

@druciak druciak left a comment

Choose a reason for hiding this comment

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

Satel looks good

joni1993 pushed a commit to joni1993/openhab-addons that referenced this pull request Oct 15, 2024
@lsiepel @joni1993
Multiple binding markdown fixes (openhab#17422)
4a2881f 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
matchews pushed a commit to matchews/openhab-addons that referenced this pull request Oct 18, 2024
@lsiepel @matchews
Multiple binding markdown fixes (openhab#17422)
e8a68bf 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
@mlobstein mlobstein mentioned this pull request Oct 23, 2024
Merged
@jlaur jlaur mentioned this pull request Oct 28, 2024
Merged
cipianpascu pushed a commit to cipianpascu/openhab-addons that referenced this pull request Jan 2, 2025
@lsiepel
Multiple binding markdown fixes (openhab#17422)
3b47422 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@druciak druciak druciak left review comments

@andrewfg andrewfg andrewfg approved these changes

@psmedley psmedley psmedley approved these changes

@holgerfriedrich holgerfriedrich holgerfriedrich approved these changes

@stefan-hoehn stefan-hoehn stefan-hoehn approved these changes

@wborn wborn wborn approved these changes

@jlaur jlaur jlaur approved these changes

@mlobstein mlobstein mlobstein approved these changes

@morph166955 morph166955 morph166955 approved these changes

@janvyb janvyb janvyb approved these changes

@florian-h05 florian-h05 florian-h05 approved these changes

@gbicskei gbicskei Awaiting requested review from gbicskei gbicskei is a code owner

@ssalonen ssalonen Awaiting requested review from ssalonen ssalonen is a code owner

@kaikreuzer kaikreuzer Awaiting requested review from kaikreuzer kaikreuzer is a code owner

@andylintner andylintner Awaiting requested review from andylintner andylintner is a code owner

@ccutrer ccutrer Awaiting requested review from ccutrer ccutrer is a code owner

@yfre yfre Awaiting requested review from yfre yfre is a code owner

@jamesmelville jamesmelville Awaiting requested review from jamesmelville jamesmelville is a code owner

@cweitkamp cweitkamp Awaiting requested review from cweitkamp cweitkamp is a code owner

@theater theater Awaiting requested review from theater theater is a code owner

@clinique clinique Awaiting requested review from clinique clinique is a code owner

@trokohl trokohl Awaiting requested review from trokohl trokohl is a code owner

@hmerk hmerk Awaiting requested review from hmerk hmerk is a code owner

@lolodomo lolodomo Awaiting requested review from lolodomo lolodomo is a code owner

@GiviMAD GiviMAD Awaiting requested review from GiviMAD GiviMAD is a code owner

@FlorianSW FlorianSW Awaiting requested review from FlorianSW FlorianSW is a code owner

@dalgwen dalgwen Awaiting requested review from dalgwen dalgwen is a code owner

@jochen314 jochen314 Awaiting requested review from jochen314 jochen314 is a code owner

@pravussum pravussum Awaiting requested review from pravussum pravussum is a code owner

@digitaldan digitaldan Awaiting requested review from digitaldan digitaldan is a code owner

@zarusz zarusz Awaiting requested review from zarusz zarusz is a code owner

@cedricboon cedricboon Awaiting requested review from cedricboon cedricboon is a code owner

@weymann weymann Awaiting requested review from weymann weymann is a code owner

@paulianttila paulianttila Awaiting requested review from paulianttila paulianttila is a code owner

@soenkekueper soenkekueper Awaiting requested review from soenkekueper soenkekueper is a code owner

@jimtng jimtng Awaiting requested review from jimtng jimtng is a code owner

@mhilbush mhilbush Awaiting requested review from mhilbush mhilbush is a code owner

@miloit miloit Awaiting requested review from miloit miloit is a code owner

@Skinah Skinah Awaiting requested review from Skinah Skinah is a code owner

@CSchlipp CSchlipp Awaiting requested review from CSchlipp CSchlipp is a code owner

@grro grro Awaiting requested review from grro grro is a code owner

@tdeckers tdeckers Awaiting requested review from tdeckers tdeckers is a code owner

@Jamstah Jamstah Awaiting requested review from Jamstah Jamstah is a code owner

@hww3 hww3 Awaiting requested review from hww3 hww3 is a code owner

@mherwege mherwege Awaiting requested review from mherwege mherwege is a code owner

@J-N-K J-N-K Awaiting requested review from J-N-K J-N-K is a code owner

@kjoglum kjoglum Awaiting requested review from kjoglum kjoglum is a code owner

@kgoderis kgoderis Awaiting requested review from kgoderis kgoderis is a code owner

@renescherer renescherer Awaiting requested review from renescherer renescherer is a code owner

@fazioa fazioa Awaiting requested review from fazioa fazioa is a code owner

@alexf2015 alexf2015 Awaiting requested review from alexf2015 alexf2015 is a code owner

@chaton78 chaton78 Awaiting requested review from chaton78 chaton78 is a code owner

@markus7017 markus7017 Awaiting requested review from markus7017 markus7017 is a code owner

@seime seime Awaiting requested review from seime seime is a code owner

@tisoft tisoft Awaiting requested review from tisoft tisoft is a code owner

@dougculnane dougculnane Awaiting requested review from dougculnane dougculnane is a code owner

@martinvw martinvw Awaiting requested review from martinvw martinvw is a code owner

@crnjan crnjan Awaiting requested review from crnjan crnjan is a code owner

@peuter peuter Awaiting requested review from peuter peuter is a code owner

@jeremystucki jeremystucki Awaiting requested review from jeremystucki jeremystucki is a code owner

@octa22 octa22 Awaiting requested review from octa22 octa22 is a code owner

@gnlpfjh gnlpfjh Awaiting requested review from gnlpfjh gnlpfjh is a code owner

@jsjames jsjames Awaiting requested review from jsjames jsjames is a code owner

@mvalla mvalla Awaiting requested review from mvalla mvalla is a code owner

@jjlauterbach jjlauterbach Awaiting requested review from jjlauterbach jjlauterbach is a code owner

@pail23 pail23 Awaiting requested review from pail23 pail23 is a code owner

@ntruchsess ntruchsess Awaiting requested review from ntruchsess ntruchsess is a code owner

@giovannimirulla giovannimirulla Awaiting requested review from giovannimirulla giovannimirulla is a code owner

@marcelrv marcelrv Awaiting requested review from marcelrv marcelrv is a code owner

@sprehn sprehn Awaiting requested review from sprehn sprehn is a code owner

@syphr42 syphr42 Awaiting requested review from syphr42 syphr42 is a code owner

@cschneider cschneider Awaiting requested review from cschneider cschneider is a code owner

@tavalin tavalin Awaiting requested review from tavalin tavalin is a code owner

@Cossey Cossey Awaiting requested review from Cossey Cossey is a code owner

@bruestel bruestel Awaiting requested review from bruestel bruestel is a code owner

@matchews matchews Awaiting requested review from matchews matchews is a code owner

@nils-bauer nils-bauer Awaiting requested review from nils-bauer nils-bauer is a code owner

@SamuelBrucksch SamuelBrucksch Awaiting requested review from SamuelBrucksch SamuelBrucksch is a code owner

@Andy2003 Andy2003 Awaiting requested review from Andy2003 Andy2003 is a code owner

@Nebula83 Nebula83 Awaiting requested review from Nebula83 Nebula83 is a code owner

@fruggy83 fruggy83 Awaiting requested review from fruggy83 fruggy83 is a code owner

@gdolfen gdolfen Awaiting requested review from gdolfen gdolfen is a code owner

@limdul79 limdul79 Awaiting requested review from limdul79 limdul79 is a code owner

@DerOetzi DerOetzi Awaiting requested review from DerOetzi DerOetzi is a code owner

@RSStephens RSStephens Awaiting requested review from RSStephens RSStephens is a code owner

@Friesoch Friesoch Awaiting requested review from Friesoch Friesoch is a code owner

@MikeJMajor MikeJMajor Awaiting requested review from MikeJMajor MikeJMajor is a code owner

@lujop lujop Awaiting requested review from lujop lujop is a code owner

@BobRak BobRak Awaiting requested review from BobRak BobRak is a code owner

@david-pace david-pace Awaiting requested review from david-pace david-pace is a code owner

@GerdZanker GerdZanker Awaiting requested review from GerdZanker GerdZanker is a code owner

@pfink pfink Awaiting requested review from pfink pfink is a code owner

@blafois blafois Awaiting requested review from blafois blafois is a code owner

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
4.3
Development

Successfully merging this pull request may close these issues.