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

Update Paper UI and HABmin references in add-on documentation #8607

Closed
wborn opened this issue Sep 29, 2020 · 7 comments · Fixed by #10637
Closed

Update Paper UI and HABmin references in add-on documentation #8607

wborn opened this issue Sep 29, 2020 · 7 comments · Fixed by #10637
Labels
documentation
Milestone
3.1

Comments

@wborn
Copy link
Member

wborn commented Sep 29, 2020 •
edited
Loading

Many add-on README.md files reference or contain instructions for "Paper UI" or HABmin which are UIs that no longer exists in OH3.
@wborn wborn changed the title Update Paper UI references in add-on documentation Update Paper UI and HABmin references in add-on documentation Sep 29, 2020
@bobadair bobadair mentioned this issue Oct 4, 2020
Merged
@wborn wborn added this to the 3.0 milestone Oct 6, 2020
@wborn wborn pinned this issue Dec 7, 2020
@Skinah
Copy link
Contributor

Skinah commented Dec 11, 2020 •
edited
Loading

I can probably contribute to this especially after next week when I get some holidays.
Some questions:

  • What is the preferred replacement text for PaperUI? replace with 'the UI' ?
  • What is preferred, one PR per readme ?
  • If other typos or grammar are noticed, is it ok to include them in the same PR ?
  • Can we advertise this on the forum if not already done? Better to get people that can not code, to look at doing this if possible.

@wborn
Copy link
Member Author

wborn commented Dec 11, 2020 •
edited
Loading

Thanks for your help @Skinah!

What is the preferred replacement text for PaperUI? replace with 'the UI' ?

Perhaps @ghys can answer that? I would personally go with "... the Main UI ..."

What is preferred, one PR per readme ?
If other typos or grammar are noticed, is it ok to include them in the same PR ?

It will probably be more efficient to fix multiple READMEs per PR. If they are small typos/fixes you can also add them to such PRs. 👍

Can we advertise this on the forum if not already done? Better to get people that can not code, to look at doing this if possible.

There was just an announcement for this to get previous contributors involved openhab/openhab-docs#1133 (comment).

@kaikreuzer
Copy link
Member

What is the preferred replacement text for PaperUI? replace with 'the UI' ?

The preferred way is definitely to do completely without any references to a UI. Bindings are abstracted away from UIs as much as possible, so that UIs can evolve and change completely independent of bindings. So keeping that separation in tact as much as possible within the prosa docs would be most welcome!

Anything that needs to be explained about UIs is in general not specific to a single binding and thus should rather go to a generic place in openhab-docs!

@markus7017 markus7017 unpinned this issue Dec 15, 2020
@wborn
Copy link
Member Author

wborn commented Dec 15, 2020

Please don't unpin this issue @markus7017.

@wborn wborn pinned this issue Dec 15, 2020
@Skinah
Copy link
Contributor

Skinah commented Dec 20, 2020

Created a WIP here:
#9439

@Skinah
Copy link
Contributor

Skinah commented Dec 21, 2020

Can anyone help out?

As an update: I found around 60% as a guess needed a change and I have probably only done half the bindings. Bindings from A to L still need to be checked plus the other addons that are not bindings.

Hilbrand added a commit to Hilbrand/openhab-addons that referenced this issue Jan 21, 2021
@Hilbrand
Removal of reference to PaperUI
2fb4ba7 
Related to openhab#8607.

In some cases removed information that is actually generic information and should not be in binding readme.

Signed-off-by: Hilbrand Bouwkamp <[email protected]>
@Hilbrand Hilbrand mentioned this issue Jan 21, 2021
Merged
wborn pushed a commit that referenced this issue Jan 22, 2021
@Hilbrand
Removal of reference to PaperUI (#9905)
8889762 
Related to #8607.

In some cases removed information that is actually generic information and should not be in binding readme.

Signed-off-by: Hilbrand Bouwkamp <[email protected]>
@openhab-bot
Copy link
Collaborator

This issue has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/documentation-on-item-creation-in-oh3/116987/3

@marcelrv marcelrv unpinned this issue Apr 16, 2021
@Hilbrand Hilbrand pinned this issue Apr 21, 2021
wborn added a commit to wborn/openhab-addons that referenced this issue May 2, 2021
@wborn
Update remaining Paper UI and HABmin references
15e8481 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
@wborn wborn mentioned this issue May 2, 2021
Merged
kaikreuzer pushed a commit that referenced this issue May 6, 2021
@wborn
Update remaining Paper UI and HABmin references (#10637)
cfea5a2 
Fixes #8607

Signed-off-by: Wouter Born <[email protected]>
@wborn wborn unpinned this issue May 6, 2021
@wborn wborn modified the milestones: 3.0, 3.1 May 6, 2021
@wborn wborn removed the help wanted label May 6, 2021
themillhousegroup pushed a commit to themillhousegroup/openhab2-addons that referenced this issue May 10, 2021
@Hilbrand @themillhousegroup
Removal of reference to PaperUI (openhab#9905)
54a970d 
Related to openhab#8607.

In some cases removed information that is actually generic information and should not be in binding readme.

Signed-off-by: Hilbrand Bouwkamp <[email protected]>
Signed-off-by: John Marshall <[email protected]>
themillhousegroup pushed a commit to themillhousegroup/openhab2-addons that referenced this issue May 10, 2021
@wborn @themillhousegroup
Update remaining Paper UI and HABmin references (openhab#10637)
91fad7d 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
Signed-off-by: John Marshall <[email protected]>
computergeek1507 pushed a commit to computergeek1507/openhab-addons that referenced this issue Jul 13, 2021
@wborn @computergeek1507
Update remaining Paper UI and HABmin references (openhab#10637)
07e7425 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
frederictobiasc pushed a commit to frederictobiasc/openhab-addons that referenced this issue Oct 26, 2021
@wborn @frederictobiasc
Update remaining Paper UI and HABmin references (openhab#10637)
49994b6 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this issue Nov 7, 2021
@Hilbrand @thinkingstone
Removal of reference to PaperUI (openhab#9905)
02db076 
Related to openhab#8607.

In some cases removed information that is actually generic information and should not be in binding readme.

Signed-off-by: Hilbrand Bouwkamp <[email protected]>
thinkingstone pushed a commit to thinkingstone/openhab-addons that referenced this issue Nov 7, 2021
@wborn @thinkingstone
Update remaining Paper UI and HABmin references (openhab#10637)
8427929 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this issue May 5, 2022
@Hilbrand
Removal of reference to PaperUI (openhab#9905)
d7a3c80 
Related to openhab#8607.

In some cases removed information that is actually generic information and should not be in binding readme.

Signed-off-by: Hilbrand Bouwkamp <[email protected]>
marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this issue May 5, 2022
@wborn
Update remaining Paper UI and HABmin references (openhab#10637)
cab9c9c 
Fixes openhab#8607

Signed-off-by: Wouter Born <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
3.1
Development

Successfully merging a pull request may close this issue.

Update remaining Paper UI and HABmin references wborn/openhab-addons
4 participants
@kaikreuzer @openhab-bot @wborn @Skinah