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

Questions/thoughts around a framework for configng. #29

Closed
schwar3kat opened this issue Dec 13, 2023 · 1 comment
Closed

Questions/thoughts around a framework for configng. #29

schwar3kat opened this issue Dec 13, 2023 · 1 comment
Assignees

Comments

@schwar3kat
Copy link
Collaborator

schwar3kat commented Dec 13, 2023

@Tearran @igorpecovnik
"About
Next generation bash based configuration API"
Configng doesn't appear to be an API. Is it an API? Is it perhaps a bash based menu driven configuration utility or something else?

Some thoughts/questions about a framework:
First...
Should the framework support multiple languages by design for all displayed text, menu's, and all dialogs? Is there any other Armbian project doing this well that can be used as a template? See #26 (comment)
Should the framework promote documentation as a required development element? Is there any other Armbian project doing this well that can be used as a template?
Should the framework require logical defined naming conventions for functions and variables? Is there any other Armbian project doing this well that can be used as a template?
Should the framework include any elements promoting accessibility, if so which and how?

Then...
What kind of structure should menu system have (scalable nesting/infinite nesting/limited nesting)?
What format should the menu configuration be? (some ideas exist. in the light of the above, are they suitable as a starting point).
What kind of structure should menu driven functions have? (some development exists. in the light of the above, is it suitable as a starting point).
What kind of extensible structure should reusable code elements have (functions, board variables and etc. Modular/monolithic. Format, location)? For context, armbian-config has these. Can we do better?

@schwar3kat
Copy link
Collaborator Author

Developer documentation should possibly be included in the code, and could possibly be exported to be accessible from and formatted for Github. It should describe how the function works, it's structure, it's interactions and requirements. This can possibly be enabled to some extent with a form in the header and or comments. The key here, I think, would be to provide a framework for developers to fill in, attached to each function.

In my opinion, end user documentation should probably be geared towards providing end user instructions in a format compatible with https://docs.armbian.com/User-Guide_Armbian-Config/ for inclusion into that website. This can be done via https://github.com/armbian/documentation.

Each menu function could have a thorough description and illustrated user instructions, preferably with screen shots. Anything auto-generated, will almost certainly require editing and proof-reading before inclusion. Some means of ensuring that it happens before the change PR is accepted would be good. Perhaps Github workflow.

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

No branches or pull requests

2 participants