Skip to content

Add info on teaching automations#5975

Merged
MartinHjelmare merged 2 commits intonextfrom
robmarkcole-patch-4
Aug 8, 2018
Merged

Add info on teaching automations#5975
MartinHjelmare merged 2 commits intonextfrom
robmarkcole-patch-4

Conversation

@robmarkcole
Copy link
Copy Markdown
Contributor

Description:
Add info on teaching automations, since the teaching events were removed

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@ghost ghost assigned robmarkcole Aug 8, 2018
@ghost ghost added the ready-for-review This PR needs to be reviewed label Aug 8, 2018

Any errors on teaching will be reported in the logs. If you enable [system_log](https://www.home-assistant.io/components/system_log/) events:

{% raw %}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Only templates require the raw tags.

Copy link
Copy Markdown
Contributor

@tjorim tjorim Aug 8, 2018

Choose a reason for hiding this comment

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

Could you please expand on that a bit more? When to use, when not etc.
This is pretty unclear in the 'documentation documentation' in my opinion.

e.g.

Configuration

The Configuration Variables section must use the {% raw %}{% configuration %} ... {% endconfiguration %}{% endraw %} tag.

The '... tag', I see multiple tags? Should we use both those tags or is it in this case just poorly rendered and do we only use the {% configuration %}-tag?

Embedding Code

You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in {% raw %}`{% endraw %}.

Are those {% raw %}-tags something we should include? Is this again a case of bad rendering and does the documentation actually just mean to use ` for inline code?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@tjorim my reading of it is that only the contents of the yaml (i.e. configuration) files should be enclosed in the raw, so my example service data should NOT be enclosed. Is this correct @MartinHjelmare ?

Copy link
Copy Markdown
Member

@MartinHjelmare MartinHjelmare Aug 8, 2018

Choose a reason for hiding this comment

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

We don't want jekyll to try to process the curly braces in jinja templates. So we use the raw tag to temporarily disable tag processing. Read more here eg:
http://ozzieliu.com/2016/04/26/writing-liquid-template-in-markdown-with-jekyll/

So to answer the question, only literal yaml that contains templates, ie curly braces, needs to be contained within raw tags. But of course there are other cases where we need to disable tag processing. Trying to list that is out of scope for this review.

@MartinHjelmare MartinHjelmare merged commit df56aaa into next Aug 8, 2018
@ghost ghost removed the ready-for-review This PR needs to be reviewed label Aug 8, 2018
@frenck
Copy link
Copy Markdown
Member

frenck commented Aug 8, 2018

Merged a little too quickly.. there was a spelling error.

fire_event: true
```

you can create an automation to receive notifications on Facebox errors:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

you -> You

@frenck
Copy link
Copy Markdown
Member

frenck commented Aug 8, 2018

Furthermore, this is not related to a parent PR, so it targets an incorrect branch. It should have been the current branch.

@frenck frenck added enhancement next This PR goes into the next branch labels Aug 8, 2018
@MartinHjelmare
Copy link
Copy Markdown
Member

No it is related to a parent PR. It was just not linked.

@frenck
Copy link
Copy Markdown
Member

frenck commented Aug 8, 2018

@MartinHjelmare In that case, it should have been linked before merging.

Could @robmarkcole or you add the link please?

dbrowndan pushed a commit to dbrowndan/home-assistant.io that referenced this pull request Aug 8, 2018
* Add info on teaching automations

* tidy raw tags
@MartinHjelmare
Copy link
Copy Markdown
Member

This was a follow up of #5789.

@frenck
Copy link
Copy Markdown
Member

frenck commented Aug 9, 2018

Thanks, @MartinHjelmare! 👍

Parent PR: home-assistant/core#15439

@frenck frenck added the has-parent This PR has a parent PR in another repo label Aug 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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