Skip to content

Rework modbus documentation.#17874

Merged
frenck merged 18 commits intohome-assistant:nextfrom
janiversen:rework
May 25, 2021
Merged

Rework modbus documentation.#17874
frenck merged 18 commits intohome-assistant:nextfrom
janiversen:rework

Conversation

@janiversen
Copy link
Copy Markdown
Member

@janiversen janiversen commented May 18, 2021

Proposed change

The modbus documentation had become a bit "clouded" and information was not logically grouped. This PR tries to make a more logical view of how the configuration works, as well as making it easier to use the index.

It is based on next instead of current, due to the pending changes (2021.6) which are on next.

This also contains the documentation for the new Fan and Light platforms.

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

I am not a native English speaker so suggestions to correct the wording will be accepted immediately.

Incorporates #15329, which are closed.
Incorporates #17207, which are closed.

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.

@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 May 18, 2021
@probot-home-assistant probot-home-assistant Bot added the next This PR goes into the next branch label May 18, 2021
@janiversen
Copy link
Copy Markdown
Member Author

It tells me line 8 is wrong, but I did not touch the first lines at all, I am confused.

@janiversen
Copy link
Copy Markdown
Member Author

@frenck Can I politely ask for advice...the build tell I have an error in line#8 column 284. But the commit does not touch line 8 (first line touched is 21, and that looks ok to me). Can you give a hint where/how to search for the problem ?

thanks in advance.

Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
@janiversen janiversen requested a review from klaasnicolaas May 19, 2021 22:53
@janiversen
Copy link
Copy Markdown
Member Author

How super to see the site in a PR. This PR is ready from my side.

@janiversen janiversen removed 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 May 20, 2021
@probot-home-assistant probot-home-assistant Bot added the has-parent This PR has a parent PR in another repo label May 21, 2021
@janiversen janiversen added the parent-merged The parent PR has been merged already label May 21, 2021
@janiversen janiversen self-assigned this May 21, 2021
@janiversen
Copy link
Copy Markdown
Member Author

Do I miss to do something (it is no good idea, that I approve my own work) ? Code is coming in 2021.6 so I hope this doc. will as well.

Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
Comment thread source/_integrations/modbus.markdown Outdated
janiversen and others added 2 commits May 25, 2021 12:40
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
janiversen and others added 9 commits May 25, 2021 12:41
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Comment thread source/_integrations/modbus.markdown Outdated
@frenck frenck removed the request for review from klaasnicolaas May 25, 2021 15:17
@frenck frenck dismissed klaasnicolaas’s stale review May 25, 2021 15:18

Comment addressed.

@frenck frenck merged commit b62714b into home-assistant:next May 25, 2021
@probot-home-assistant probot-home-assistant Bot removed the parent-merged The parent PR has been merged already label May 25, 2021
@janiversen janiversen deleted the rework branch May 26, 2021 14:30
@github-actions github-actions Bot locked and limited conversation to collaborators May 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed has-parent This PR has a parent PR in another repo next This PR goes into the next branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants