Skip to content

Refactor of documentation method for components (2019-0016)#8265

Merged
klaasnicolaas merged 3 commits intocurrentfrom
frenck-2019-0016
Jan 24, 2019
Merged

Refactor of documentation method for components (2019-0016)#8265
klaasnicolaas merged 3 commits intocurrentfrom
frenck-2019-0016

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented Jan 24, 2019

Description:

Currently, we have tons of platform pages, that tells the user to go look at the component/hub page.
As a result of this, we have a lot of "Hub" pages, for things that are actually not a hub.

This PR tries to solve that and adds/optimizes some other things in the process.

Changes

  • Adds support for specifying multiple categories in the ha_category frontmatter variable. While maintaining backwards compatibility.
  • Ensured component still shows up in multiple categories (including search)
  • Changed featured items category to ensure the component is only listed once (for the first category)
  • Adds support for the ha_config_flow frontmatter variable, which will show a notice about this component being configurable via the UI on the component page.
  • Adds a little more spacing around the logo's shown on the components page.
  • Removes the list of other components in the same category from the component page (this reduces built times significantly): Added list of categories this component is in instead.
  • Migrated the Ikea Tradfri as an example:
    • Removed platform pages (sensor, light, switch)
    • Added redirect_from to the main component page in order to keep old URL's working
    • Added Light, Switch and Sensor as categories, removed it from Hub.
    • Marked ha_config_flow since it does support that.

image

Pull request in home-assistant (if applicable): n/a

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created against current.
  • The documentation follows the standards.

@frenck frenck added enhancement ready-for-review This PR needs to be reviewed current This PR goes into the current branch labels Jan 24, 2019
@ghost ghost assigned frenck Jan 24, 2019
Copy link
Copy Markdown
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

Awesome!

Copy link
Copy Markdown
Member

@klaasnicolaas klaasnicolaas left a comment

Choose a reason for hiding this comment

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

This is great! 😄

@balloob
Copy link
Copy Markdown
Member

balloob commented Jan 24, 2019

@klaasnicolaas you can merge this one 👍

@klaasnicolaas klaasnicolaas merged commit 92fb95d into current Jan 24, 2019
@delete-merged-branch delete-merged-branch Bot deleted the frenck-2019-0016 branch January 24, 2019 22:17
@ghost ghost removed the ready-for-review This PR needs to be reviewed label Jan 24, 2019
@klaasnicolaas
Copy link
Copy Markdown
Member

Thnx for your PR @frenck 😄

@frenck
Copy link
Copy Markdown
Member Author

frenck commented Jan 24, 2019

Congratz on merging your first PR on the org @klaasnicolaas 🏅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

current This PR goes into the current branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants