Skip to content

Improve glossary #3612

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

Closed
fabaff opened this issue Oct 13, 2017 · 9 comments
Closed

Improve glossary #3612

fabaff opened this issue Oct 13, 2017 · 9 comments
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest!

Comments

@fabaff
Copy link
Member

fabaff commented Oct 13, 2017

If #3568 we introduced the new Glossary. Now, we need to make it as user-friendly as possible.

It's very simple to contribute, just edit/update/modify the data file, save it, create a PR and you are done.

@fabaff fabaff added the Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! label Oct 13, 2017
@decode-dev
Copy link

@fabaff Would like to work on this?
Any instruction on this?

@arsaboo
Copy link
Contributor

arsaboo commented Oct 13, 2017

@decode-dev Just modify the data file to update the glossary.

@fabaff
Copy link
Member Author

fabaff commented Oct 14, 2017

To be clear: This glossary is about Home Assistant's terminology and the entry should be specific to Home Assistant.

@Maxr1998
Copy link
Contributor

@fabaff what about some technical terms like Z-Wave/MQTT?

@DanielXYZ2000
Copy link
Contributor

From my point of view Z-Wave and MQTT are not Home Assistant related. But I think it would be good to have also these technical terms in a glossary.
Maybe we could make a general one?
Or maybe the glossary entries could be tagged (hass, general,...)?

@fabaff
Copy link
Member Author

fabaff commented Oct 16, 2017

Let's stick to terms which are relevant for Home Assistant.

@fabaff
Copy link
Member Author

fabaff commented Oct 16, 2017

I think that if you can use a search engine for a term and get results we only would duplicate existing definitions. Sure, there is a grey area but if we start to create a glossary for "common" terms it would be a never ending list.

I'm open-minded. The glossary is something new and if people think that it add value then we should do.

@fabaff
Copy link
Member Author

fabaff commented Oct 16, 2017

@DanielXYZ2000 tagging should definitely be considered.

@Maxr1998
Copy link
Contributor

Maxr1998 commented Oct 16, 2017

@fabaff ok, thanks for clarifying.

@fabaff fabaff closed this as completed Oct 20, 2017
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!
Projects
None yet
Development

No branches or pull requests

5 participants