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

create jsonConfig guide based on schema.md #2781

Merged
merged 7 commits into from
Nov 2, 2024

Conversation

oweitman
Copy link
Contributor

No description provided.

@GermanBluefox
Copy link
Contributor

Looks cool. Thank you!
Have you created settings automatically or manually?

@mcm1957
Copy link
Contributor

mcm1957 commented Oct 27, 2024

Formatting and explanation looks good.

BUT why do we need TWO files here?
Why not adapting the existing SCHEMA.md and adapt formatting and instructs there?

Two files with same information are getting inkonstitent for sure if they are not created by an automatism. Of course a README.md can be created and SCHEMA.md be removed. But in this case do not forget to leave a minimum SCHEMA.md pointing to to new documentation as it will last some time to change all referneces pointing at SCHAME,md

@oweitman
Copy link
Contributor Author

because this is just a proposal and I don't know if it will be accepted. Also, I didn't want to delete bluefox schema.md.
if someone thinks the document is good enough to replace schema.md, then I'm fine with that.

@mcm1957
Copy link
Contributor

mcm1957 commented Oct 27, 2024

Ok, the proposal would not replace anything until ist merged :-)
I only want to point out that we should not have 2 Places with identical documentation which are not synched automatically. And at the first look I did not recognize that you created a new file - was focused on content.

Think BF will take care of this.

@oweitman
Copy link
Contributor Author

Looks cool. Thank you! Have you created settings automatically or manually?

which settings?
the md settings?
i didnt install anything in the repo.
i only installed the vs code extension markdownlinter
https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

@mcm1957
Copy link
Contributor

mcm1957 commented Oct 29, 2024

Possible ERROR:

I could not finde the attributes for tabs, i.e. tabsStyle.
The attributes are mentioned here:

tabs - Tabs with items

items - Object with panels {"tab1": {}, "tab2": {}...}

iconPosition - bottom, end, start or top. Only for panels that has icon attribute. Default: start
tabsStyle - CSS Styles in React format (marginLeft and not margin-left) for the Mui-Tabs component
panel - Tab with items

icon - tab can have icon (base64 like data:image/svg+xml;base64,...) or jpg/png images (ends with .png)

label - Label of tab
items - Object {"attr1": {}, "attr2": {}}...
collapsable - only possible as not part of tabs[jsonConfig.json](https://github.com/ioBroker/ioBroker.admin/blob/master/packages/jsonConfig/..%2F..%2F..%2F..%2F..%2FioBroker.ring%2Fadmin%2FjsonConfig.json)
color - color of collapsable header primary or secondary or nothing
innerStyle - CSS Styles for inner div in React format (marginLeft and not margin-left) for the Panel component. Not used for collapsable panels.

Please verify - maybe I did not search the right way.

ENHANCEMENT / SUGGESTION:
I suggest to add the minimum admin version required to use an object to every element at (preferable at overview table). So user could easily adjust their dependency correctly.

@oweitman
Copy link
Contributor Author

oweitman commented Oct 30, 2024

thank you for detailed verification
yes, I missed the 2 elements Tabs and Panel, I added these in the last commit

the minimum version is already mentioned. in general in section ## What you'll need
and if different in the element list and element details (i added a missing one)

Additionally, I have sorted the element index alphabetically

@mcm1957
Copy link
Contributor

mcm1957 commented Oct 31, 2024

the minimum version is already mentioned. in general in section ## What you'll need and if different in the element list and element details (i added a missing one)

Additionally, I have sorted the element index alphabetically

Thanks for adding and for sorting the indis. Was a good idea.

I still think, that noting the exact admin version required qould be a good idea. The notes from scema.md are incomplete. I do not think that i.e. devicemanager is working with admin 6.0.0 - but I did not test it. Where this information is notes - at the index tanle or at the heading area of every element is secondary. Adding to index would have the benefit t detect missing info easier but technical it should be located near the descripton of the component.

Anyway this is not 100% related to the PR so its ok for me to wait until PR is merged and to open a issue afterwards

@oweitman
Copy link
Contributor Author

oweitman commented Oct 31, 2024

I only have the informations about the versions that are mentioned in the schema.md

@mcm1957
Copy link
Contributor

mcm1957 commented Oct 31, 2024

Bitte noch sendto in sendTo ändern. Das war/ist auch in Schema.md falsch
#2792

@oweitman
Copy link
Contributor Author

erledigt

@GermanBluefox GermanBluefox merged commit 0f81ab7 into ioBroker:master Nov 2, 2024
15 checks passed
@oweitman
Copy link
Contributor Author

oweitman commented Nov 2, 2024

thank you for merge

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

Successfully merging this pull request may close these issues.

3 participants