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

Add warning if config is marked as untested #114

Closed
MagicLike opened this issue Mar 16, 2023 · 13 comments
Closed

Add warning if config is marked as untested #114

MagicLike opened this issue Mar 16, 2023 · 13 comments
Labels
enhancement New feature or request

Comments

@MagicLike
Copy link
Member

For experimental or untested configs it would be nice to have a config metadata to mark it as experimental/untested and output a warning in OAI.

@tsterbak
Copy link
Member

tsterbak commented Mar 22, 2023

Thank you for the suggestion :)
What would be the reason to put a experimental or untested config to the installer?

@MagicLike
Copy link
Member Author

If it works not the same every time or if someone makes a config without having the device itself, so others can test and verify it... (Just like I recently offered someone on fedi to write a config for their device)

@MagicLike
Copy link
Member Author

Also the configs are already declared as tested or under development in the README...

@tsterbak
Copy link
Member

Also the configs are already declared as tested or under development in the README...

Yeah, I will soon try to align information in the README and in the configs (and on the website). Then the configs will be the only source of truth on what and how stuff is supported. Maybe even more details, it also came up here: #116

@anon1892
Copy link
Member

anon1892 commented Aug 2, 2023

Could also be done with #221

@MagicLike
Copy link
Member Author

Could also be done with #221

Not quite, but mayve 🤔

@anon1892
Copy link
Member

anon1892 commented Aug 2, 2023

It can look like that :

image

@MagicLike
Copy link
Member Author

It can look like that :

image

Could you also add the functionality to just flag configs as untested and then this warning in red pops up and the user needs to co firm twice to continue?

@anon1892
Copy link
Member

anon1892 commented Aug 2, 2023

I don't think it's really useful, since you just have to put this in metadata

notes: >
  - **This device has never been tested with OAI.** etc.

Instead of

untested: true

I think notes is more versatile than add another field. It's already in red and bold, users have to read… What do you think?

@MagicLike
Copy link
Member Author

I don't think it's really useful, since you just have to put this in metadata

notes: >
  - **This device has never been tested with OAI.** etc.

Instead of

untested: true

I think notes is more versatile than add another field. It's already in red and bold, users have to read… What do you think?

I think that it is better to convert as much as possible into fileds / variables, to ensure continuety and avoid spelling issues, as I occasionally find spelling issues in every config now and then... I mean another field is not neccesary, but would just look nice. Also all the warnings and notes you wrote for the Xiaomi devices could be hard coded and just set by `is_xiaomi: true. (Or something like that.) It also makes the configs more simple and not that crammed.

@anon1892
Copy link
Member

anon1892 commented Aug 2, 2023

Ok, I see. Will work on it.
Maybe should we consider #72 ?

EDIT : Done, see #221

@MagicLike
Copy link
Member Author

MagicLike commented Aug 2, 2023

Maybe should we consider #72 ?

I think this is some work for later, as @tsterbak stated - he wants OAI to have all the features and major stuff implemented first, before getting into translating it.

@MagicLike
Copy link
Member Author

resolved with #221

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants