openhab / openhab-docs

This repository contains the documentation for openHAB.

https://www.openhab.org/docs/

Other

268 stars 682 forks source link

openHAB 3 Documentation Orga - Accomplished tasks #1310

Closed Confectrician closed 3 years ago

Confectrician commented 3 years ago

Content

This post (and the following ones) will hold all tasks that have been completed so far, to get a better overview in our main orga issue.

Confectrician commented 3 years ago

Concepts Area

https://github.com/openhab/openhab-docs/blob/main/concepts/discovery.md

https://github.com/openhab/openhab-docs/blob/main/concepts/units-of-measurement.md

[x] Change Namespaces to org.openhab instead of org.eclipse.smarthome

New User Tutorial

[x] Complete rewrite (Partly done through openhab/openhab-docs#1304 )

https://github.com/openhab/openhab-docs/blob/main/tutorials/migration.md

[x] Add a new tutorial

Confectrician commented 3 years ago

Installation Area

https://github.com/openhab/openhab-docs/blob/main/installation/index.md

[x] Remove Java 8 references
[x] Change openHAB 2 references to openHAB without version number
[x] Reword the note about outdated online tutorials in a general meaning

https://github.com/openhab/openhab-docs/blob/main/installation/armbian.md

[x] get in contact with the armbian contributor to check for armbian and armbian docs updates

https://github.com/openhab/openhab-docs/blob/main/installation/linux.md

[x] Change openHAB 2 references to openHAB without version number
[x] Change Java 8 to Java 11
[x] Add note about incompatibility with Java versions higher than 11
[x] Change openhab2.list file for package repository
[x] New Screenshot for the first install window (Done #1309)
[x] check and fix folder names in examples

https://github.com/openhab/openhab-docs/blob/main/installation/rasppi.md

[x] Change java 8 link to a java 11 one

https://github.com/openhab/openhab-docs/blob/main/installation/armbian.md

[x] add a note box with a warning for possibly outdated content

https://github.com/openhab/openhab-docs/blob/main/installation/docker.md

[x] Change openHAB 2 references to openHAB without version number

https://github.com/openhab/openhab-docs/blob/main/installation/synology.md

[x] Ask @cniweb for updates/help here

https://github.com/openhab/openhab-docs/blob/main/installation/qnap.md

[x] Remove article from the sidebar for now

https://github.com/openhab/openhab-docs/blob/main/installation/windows.md

[x] remove explorer screenshot
[x] Make new console screenshots

Confectrician commented 3 years ago

Config Area

https://github.com/openhab/openhab-docs/blob/main/configuration/index.md

[x] update the whole table (probably already finished by @mstormi, #1298 )
- Remove UIs not included in OH3
- Change Paper UI references to Main UI
- Remove recommendations completely for now
- Remove any OH 1.x references
[x] Textual vs. Graphical configuration needs a complete revision
[x] Revision of the recommendations part

https://github.com/openhab/openhab-docs/blob/main/addons/actions.md

[x] Change configuration part to the new UI

https://github.com/openhab/openhab-docs/blob/main/configuration/addons.md

[x] Replace the Paper UI block
[x] Remove the OH 1.x example(s)
[x] Remove "package"
[x] Replace/Update feature:list abstract

https://github.com/openhab/openhab-docs/blob/main/configuration/things.md

[x] Remove Paper UI reference and link in the discovery part

https://github.com/openhab/openhab-docs/blob/main/configuration/items.md

[x] Remove OH 1.x references
[x] Replace Paper UI with general UI reference
[x] Remove https://next.openhab.org/docs/configuration/items.html#_1-x-binding-configuration block
[x] Revision of https://next.openhab.org/docs/configuration/items.html#_2-x-binding-configuration block
[x] Replace/Revision Paper UI links
[x] Remove expire explanation
[x] Add expire in profile block

https://github.com/openhab/openhab-docs/blob/main/tutorials/migration.md

[x] Remove completely (OH 1.x migration)

https://github.com/openhab/openhab-docs/blob/main/configuration/rules-dsl.md

[x] Additional description how rules are added via new Main UI
[x] Revision of time based examples. (solved via openhab/openhab-docs#1294)

Confectrician commented 3 years ago

Administration Area

https://github.com/openhab/openhab-docs/blob/main/administration/jsondb.md

[x] Replace example with a new one for the new UI

Confectrician commented 3 years ago

Developer Area

https://github.com/openhab/openhab-docs/blob/main/developers/contributing.md

[x] Remove OH 1 addons parts

https://github.com/openhab/openhab-docs/edit/master/developers/legacy/compatibilitylayer.md

[x] Remove completely

Confectrician commented 3 years ago

Interfaces and Ecosystem

http://next.openhab.org/docs/configuration/ui/habot/

[x] Revision/Removal of Eclipse Smarthome references (openhab/openhab-webui#641)

https://github.com/openhab/openhab-docs/blob/main/configuration/packages.md

[x] Remove package selection completely

https://github.com/openhab/openhab-docs/blob/main/configuration/homebuilder.md

[x] Remove completely

https://github.com/openhab/website/edit/master/docs/ecosystem/ifttt/readme.md

[x] Remove from Sidebar for now

mycroft (in its own repo)

[x] Remove 1.x refences (openhab/openhab-mycroft#102)

https://github.com/openhab/openhab-docs/blob/main/configuration/rules-ng.md

[x] Remove temporary