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.

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

Use the new style for configuration variables description #6385

Closed
fabaff opened this issue Sep 30, 2018 · 14 comments
Closed

Use the new style for configuration variables description #6385

fabaff opened this issue Sep 30, 2018 · 14 comments
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! help-wanted Wanna help? Jump in!

Comments

@fabaff
Copy link
Member

fabaff commented Sep 30, 2018

A while back an advance way to describe the configuration variables was introduced.

{% configuration %}
api_key:
  description: The API key to access the service.
  required: true
  type: string
name:
  description: Name to use in the frontend.
  required: false
  default: The default name to use in the frontend.
  type: string
{% endconfiguration %}

At the moment not all platform and component documentation is ported to the new style.

This the tracking issue. Please don't close but add as a reference to your Pull request.

@frenck frenck added help-wanted Wanna help? Jump in! Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! labels Sep 30, 2018
@WofWca
Copy link
Contributor

WofWca commented Oct 1, 2018

Should we open individual PRs for each page changed?

@fabaff
Copy link
Member Author

fabaff commented Oct 1, 2018

Yes, please or at least don't add 50 platforms to one Pull Request. If you want you can combine the changes for a component and its platforms.

If the Pull Requests are small it easier to spot for others which docs are in progress or already done.

@WofWca
Copy link
Contributor

WofWca commented Oct 2, 2018

I think that the documentation, in accordance to which these changes must be done, is a bit outdated.
home-assistant/developers.home-assistant#104

@Mryck Mryck mentioned this issue Oct 2, 2018
2 tasks
fabaff pushed a commit that referenced this issue Oct 2, 2018
* Style for configuration variables description

Change to new style for configuration variables description (#6385).

* Updated configuration example

* Corrected from to be required variable.

* Removed quote of decsription text.

* Corrected incorrect linebreak.

* Minor change

* Change to list
@fabaff
Copy link
Member Author

fabaff commented Oct 2, 2018

@WofWca, Doc were updated. Please feel free to improve them if you think that something is not clear.. Thanks for the feedback, BTW.

nwesterhausen added a commit to nwesterhausen/home-assistant.io that referenced this issue Oct 2, 2018
Change to new style for configuration variables description.

Related to home-assistant#6385.
fabaff pushed a commit that referenced this issue Oct 2, 2018
Change to new style for configuration variables description.

Related to #6385.
rdbahm added a commit to rdbahm/home-assistant.github.io that referenced this issue Oct 3, 2018
@ghost ghost added the to-do label Oct 3, 2018
rdbahm added a commit to rdbahm/home-assistant.github.io that referenced this issue Oct 3, 2018
Per home-assistant#6385 updating the configuration description.
@klaasnicolaas
Copy link
Member

After PR #7154 all the pages are done 😄

@farmio
Copy link
Contributor

farmio commented Jan 6, 2019

How should a configuration variable be described when it represents an enum (a string with only several acceptable values in my case)?
Just type: string and all possible values listed in the description or type: string together with keys: key?

@frenck
Copy link
Member

frenck commented Jan 15, 2019

@farmio For YAML, it is still just a string...

@frenck
Copy link
Member

frenck commented Jan 15, 2019

The last PR, #7154 has been finished and merged.

Therefore, this issue can be closed! 🎉

Thank you all for your contributions. 👍 ❤️

A major shoutout to @klaasnicolaas who has done an impressive amount of PRs on this issue!🥇

@frenck frenck closed this as completed Jan 15, 2019
@ghost ghost removed the to-do label Jan 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! help-wanted Wanna help? Jump in!
Projects
None yet
Development

No branches or pull requests

8 participants