Adapt to core changes (addon.xml) #1872

J-N-K · 2022-08-19T16:47:50Z

Signed-off-by: Jan N. Klug [email protected]

netlify · 2022-08-19T16:48:14Z

✅ 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	`e68d455`
🔍 Latest deploy log	https://app.netlify.com/sites/openhab-docs-preview/deploys/63c5a66fce13d1000986de7c
😎 Deploy Preview	https://deploy-preview-1872--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.

Confectrician · 2022-08-21T11:09:27Z

1800 changed lines are looking wrong.

Can you check if something went wrong with the commits on your side?
Looks like some of the changed files have been removed and readded identically oer line.

J-N-K · 2022-08-21T11:42:01Z

Looks like line-ending changes. According to https://github.com/openhab/openhab-docs/blob/main/.editorconfig CRLF is expected, what is exactly what I committed. Can you comment what is the correct line-ending (it seems it was LF before, according to my local git client).

Confectrician · 2022-08-23T19:00:57Z

It is ok for me the change the line endings to crlf.
I have no strong opinion on this and the file hasn't been changed in any valuable part of the suggestions.

Maybe it isn't used that often and we missed those files for a long time.
If you are fine with having that much changes in here, that would be ok for me as it is for a reason.

But ofc those changes are a bit misleading to the original intention and pr title.

J-N-K · 2022-08-23T19:09:56Z

I can revert that, not an issue. It wasn‘t even intentional, my IDE just picked up what the repo provided as suggestion. I believe in most other repos we use only LF.

Confectrician · 2022-08-23T19:54:14Z

Then i should check this in egenral and adapt the config to the generic approach, where LF would be fine at all.

In this case reverting would be good for th epr to just reflect the intentional changes.

Confectrician

Sorry, this went out of my focus for way too long.
I didn't realise, that you already fixed everything with the commits.

I have just one small finding, which i will solve myself.

developers/addon/addon.md

Found needed changes after solving the merge conflicts.

Confectrician

Again some small comments/questions, from checking the preview after solving the conflicts.

developers/addon/index.md

J-N-K · 2022-11-19T09:56:58Z

Please make sure that this is only merged after the core-PR has been merged, otherwise we'll have an inconsistent documentation.

Confectrician · 2022-11-19T13:25:57Z

I have added the dependency label and subscribed to the core pr. :)

kaikreuzer · 2023-01-14T22:04:07Z

.vuepress/docs-sidebar.js

@@ -142,7 +142,7 @@ module.exports = [
    children: [
      ['developer/', 'Overview & Introduction'],
      'developer/guidelines',
-      'developer/bindings/',


I would definitely suggest to keep the "bindings" menu in place, just as we have dedicated entries for other add-on types like automation addons, transformation services, voice add-ons etc.
What would imho make sense here is to add a new menu entry for everything that generally applies to all add-ons and this new page could then link to the different specific add-on pages as well.

The problem is that we don't have content for that page. Duplicating what is written on the general page makes no sense.

Well, a few parts could be moved from the binding page to the add-on page, like the description about the addon.xml, the info on how to add a logo for the add-on and similar.

After I did that, there was no content left :-)

Hm, I see your point, but I am a bit puzzled, because on https://www.openhab.org/docs/developer/bindings/ I see a lot more content about how to develop a binding. You seem to have moved all the files that contribute to this page to /developer/addon.

Sometimes I'm a bit slow... Is this version better?

Yes, thanks - that look better!

kaikreuzer

Do you have any idea, why Github does not properly show the changes that you made, but rather shows the full files to be changed (e.g. developers/bindings/index.md)?
This makes reviewing hard, but I just trust that there were no irrelevant changes.

kaikreuzer · 2023-01-16T19:03:26Z

developers/addons/index.md

+title: Add-ons
+---
+
+# Developing an add-on


Suggested change

# Developing an add-on

# Developing an Add-on

Yes, that's due to an incorrect .editorconfig in this repo (it defines CRLF instead of LF which is actually used).

This should be fine now.

kaikreuzer · 2023-01-16T19:04:38Z

.vuepress/docs-sidebar.js

@@ -142,7 +142,7 @@ module.exports = [
    children: [
      ['developer/', 'Overview & Introduction'],
      'developer/guidelines',
-      'developer/bindings/',


Yes, thanks - that look better!

Signed-off-by: Jan N. Klug <[email protected]>

kaikreuzer

Wonderful - that's how it should look like! 👍

Some documentation files were moved in openhab#1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]>

Some documentation files were moved in #1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]>

Some documentation files were moved in #1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]> Co-authored-by: Wouter Born <[email protected]>

J-N-K mentioned this pull request Aug 19, 2022

Introduce metadata for all add-ons openhab/openhab-core#3050

Merged

6 tasks

Confectrician added the Feedback Waiting for feedback label Sep 10, 2022

Confectrician added this to the 3.4 milestone Sep 10, 2022

J-N-K force-pushed the addons-xml branch from 133eefc to d55f62a Compare September 18, 2022 09:52

Confectrician previously approved these changes Nov 18, 2022

View reviewed changes

developers/addon/addon.md Outdated Show resolved Hide resolved

Confectrician reviewed Nov 18, 2022

View reviewed changes

developers/addon/index.md Outdated Show resolved Hide resolved

developers/addon/index.md Outdated Show resolved Hide resolved

developers/addon/index.md Outdated Show resolved Hide resolved

Confectrician removed the Feedback Waiting for feedback label Nov 18, 2022

Confectrician added the stat: dependency 💥 This issue/pr has a dependency in another repo label Nov 19, 2022

Confectrician modified the milestones: 3.4, 3.5 Dec 19, 2022

kaikreuzer requested changes Jan 14, 2023

View reviewed changes

J-N-K force-pushed the addons-xml branch 2 times, most recently from 6465800 to 5b2e346 Compare January 16, 2023 18:17

kaikreuzer reviewed Jan 16, 2023

View reviewed changes

Adjust to addon.xml

5b58baa

Signed-off-by: Jan N. Klug <[email protected]>

J-N-K force-pushed the addons-xml branch from 337b6e8 to 5b58baa Compare January 16, 2023 19:32

lineendings again

e68d455

Signed-off-by: Jan N. Klug <[email protected]>

kaikreuzer approved these changes Jan 16, 2023

View reviewed changes

kaikreuzer merged commit 71adc53 into openhab:main Jan 16, 2023

andrewfg mentioned this pull request Feb 23, 2023

[documentation] Update developer documentation to reflect changes in core and addons openhab/openhab-core#3396

Open

jlaur mentioned this pull request Apr 15, 2023

Add more connection details to add-ons openhab/openhab-addons#14813

Merged

jlaur mentioned this pull request Apr 15, 2023

Refine addon.xml connection openhab/openhab-core#3555

Closed

wborn added a commit to wborn/openhab-docs that referenced this pull request Jul 29, 2023

Fix broken links

1e2ca12

Some documentation files were moved in openhab#1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]>

wborn mentioned this pull request Jul 29, 2023

Fix broken links #2108

Merged

Confectrician pushed a commit that referenced this pull request Jul 30, 2023

Fix broken links (#2108)

010da34

Some documentation files were moved in #1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]>

github-actions bot mentioned this pull request Jul 30, 2023

Fix broken links #2109

Merged

github-actions bot pushed a commit that referenced this pull request Jul 30, 2023

Fix broken links (#2108)

2985c83

Some documentation files were moved in #1872 which caused these links to be broken. Signed-off-by: Wouter Born <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adapt to core changes (addon.xml) #1872

Adapt to core changes (addon.xml) #1872

J-N-K commented Aug 19, 2022

netlify bot commented Aug 19, 2022 •

edited

Loading

Confectrician commented Aug 21, 2022 •

edited

Loading

J-N-K commented Aug 21, 2022

Confectrician commented Aug 23, 2022

J-N-K commented Aug 23, 2022

Confectrician commented Aug 23, 2022

Confectrician left a comment

Confectrician left a comment

J-N-K commented Nov 19, 2022

Confectrician commented Nov 19, 2022

kaikreuzer Jan 14, 2023

J-N-K Jan 14, 2023

kaikreuzer Jan 14, 2023

J-N-K Jan 16, 2023

kaikreuzer Jan 16, 2023

J-N-K Jan 16, 2023

kaikreuzer Jan 16, 2023

kaikreuzer left a comment

kaikreuzer Jan 16, 2023

J-N-K Jan 16, 2023

J-N-K Jan 16, 2023

kaikreuzer Jan 16, 2023

kaikreuzer left a comment

Adapt to core changes (addon.xml) #1872

Adapt to core changes (addon.xml) #1872

Conversation

J-N-K commented Aug 19, 2022

netlify bot commented Aug 19, 2022 • 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).

Confectrician commented Aug 21, 2022 • edited Loading

J-N-K commented Aug 21, 2022

Confectrician commented Aug 23, 2022

J-N-K commented Aug 23, 2022

Confectrician commented Aug 23, 2022

Confectrician left a comment

Choose a reason for hiding this comment

Confectrician left a comment

Choose a reason for hiding this comment

J-N-K commented Nov 19, 2022

Confectrician commented Nov 19, 2022

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

kaikreuzer 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

kaikreuzer left a comment

Choose a reason for hiding this comment

netlify bot commented Aug 19, 2022 •

edited

Loading

Confectrician commented Aug 21, 2022 •

edited

Loading