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 zwave_js migration docs #19432

Merged
merged 1 commit into from
Oct 16, 2021
Merged

Update zwave_js migration docs #19432

merged 1 commit into from
Oct 16, 2021

Conversation

MartinHjelmare
Copy link
Member

@MartinHjelmare MartinHjelmare commented Sep 22, 2021 •
edited by raman325
Loading

Proposed change

  • Update zwave_js integration docs regarding migration. There's now a migration wizard backend implementation from zwave to zwave_js in the linked parent PR.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

@MartinHjelmare MartinHjelmare requested a review from a team as a code owner September 22, 2021 14:25
@probot-home-assistant probot-home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Sep 22, 2021
@MartinHjelmare MartinHjelmare mentioned this pull request Sep 22, 2021
Merged
25 tasks
frenck
frenck previously approved these changes Sep 22, 2021
View reviewed changes
source/_integrations/zwave_js.markdown
If you're new to Home Assistant, use Z-Wave JS.

The `zwave` integration has been marked as deprecated and will no longer receive any updates like new device files. The `ozw` integration will receive new device files if they are provided by upstream.

It is perfectly doable to switch over from one of the above mentioned previous integrations to the new Z-Wave JS integration. The good news is that your entire Z-Wave network is **stored on your stick** so you will not have to run through your house to recreate your network. That said, we currently do not provide a full-fledged, worry-free, click-a-button, migration from old to new. We're exploring options to provide this in the future. This means that if you want to switch over now, *you* will be the migration wizard.
It is perfectly doable to switch over from one of the above mentioned previous integrations to the new Z-Wave JS integration. The good news is that your entire Z-Wave network is **stored on your stick** so you will not have to run through your house to recreate your network.

Copy link
Member

Choose a reason for hiding this comment

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

The old z-wave integration is already marked deprecated, so it had a proper notice?

Copy link
Member Author

Choose a reason for hiding this comment

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

We've said it's deprecated, not that it will be removed or when it will be removed. I think we can change that part separately.

@frenck frenck added the awaits-parent Awaits the merge of an parent PR label Sep 22, 2021
raman325
raman325 previously approved these changes Sep 22, 2021
View reviewed changes
Copy link
Contributor

@raman325 raman325 left a comment

Choose a reason for hiding this comment

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

LGTM

@MartinHjelmare
Copy link
Member Author

We missed to include this in last release. Should we rebase it against current?

@raman325
Copy link
Contributor

We missed to include this in last release. Should we rebase it against current?

Glad you caught that. I would say so 👍

@raman325 raman325 changed the base branch from next to current October 16, 2021 03:57
@raman325 raman325 dismissed stale reviews from frenck and themself October 16, 2021 03:57

The base branch was changed.

@probot-home-assistant probot-home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Oct 16, 2021
@probot-home-assistant probot-home-assistant bot added current This PR goes into the current branch and removed next This PR goes into the next branch labels Oct 16, 2021
@probot-home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.
(message by DocsTargetBranch)

@raman325 raman325 removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Oct 16, 2021
@raman325 raman325 merged commit d1fa0eb into current Oct 16, 2021
@probot-home-assistant probot-home-assistant bot removed in-progress This PR/Issue is currently being worked on awaits-parent Awaits the merge of an parent PR labels Oct 16, 2021
@delete-merged-branch delete-merged-branch bot deleted the update-zwave-js-migration branch October 16, 2021 03:59
@raman325 raman325 added the parent-merged The parent PR has been merged already label Oct 16, 2021
@MartinHjelmare
Copy link
Member Author

Thanks!

@github-actions github-actions bot locked and limited conversation to collaborators Oct 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@raman325 raman325 raman325 approved these changes

@frenck frenck frenck left review comments

Assignees

@raman325 raman325

Labels
cla-signed current This PR goes into the current branch has-parent This PR has a parent PR in a other repo parent-merged The parent PR has been merged already
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@MartinHjelmare @raman325 @frenck @homeassistant