Skip to content

Add link to integration docs from service control#8290

Merged
bramkragten merged 5 commits intohome-assistant:devfrom
spacegaier:issue-8278
Apr 26, 2021
Merged

Add link to integration docs from service control#8290
bramkragten merged 5 commits intohome-assistant:devfrom
spacegaier:issue-8278

Conversation

@spacegaier
Copy link
Copy Markdown
Member

@spacegaier spacegaier commented Jan 30, 2021

Breaking change

Proposed change

Adds a help icon with a link tot he integration documentation for the selected service domain.

UI mode:
image

YAML mode:
image

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

@spacegaier
Copy link
Copy Markdown
Member Author

@bramkragten Is this PR something that you think makes sense? If yes, I will resolve the merge conflicts, otherwise of course not 😄.

@bramkragten
Copy link
Copy Markdown
Member

With the new UI I don't think it is really useful anymore? The docs will be based on the same data as we show in the UI in the future.

@spacegaier
Copy link
Copy Markdown
Member Author

With the new UI I don't think it is really useful anymore? The docs will be based on the same data as we show in the UI in the future.

In the docs there can be more than just the service data, such as additional context info, examples, etc. Even though that is then not strictly tied to the service testing, it might make it easy to navigate to look up some additional details.

@bramkragten
Copy link
Copy Markdown
Member

I'll ask advise from our docs maistro, @frenck

Personally I don't really see the use...

@SeanPM5
Copy link
Copy Markdown
Contributor

SeanPM5 commented Mar 2, 2021

I could see this being useful in certain scenarios. An example would be a TTS service that supports multiple voices/languages, the available voices are usually listed in the docs.

@frenck
Copy link
Copy Markdown
Member

frenck commented Apr 26, 2021

Got pinged by @spacegaier on this matter...
I don't have an opinion on this matter.

I hope we can generate documentation for services based on the service descriptions (so in the end, it should be the same). 🤷

@spacegaier spacegaier changed the title Add link to integration help from dev tool services Add link to integration docs from service control Apr 26, 2021
Comment thread src/translations/en.json Outdated
Comment thread src/components/ha-service-control.ts Outdated
spacegaier and others added 2 commits April 26, 2021 16:55
@bramkragten bramkragten merged commit 33703a3 into home-assistant:dev Apr 26, 2021
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add URL Link to Documentation in the Service Call Tools [/developer-tools/service]

5 participants