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

Restructuring fmf documentation #266

Open
LecrisUT opened this issue Dec 3, 2024 · 0 comments
Open

Restructuring fmf documentation #266

LecrisUT opened this issue Dec 3, 2024 · 0 comments

Comments

@LecrisUT
Copy link
Contributor

LecrisUT commented Dec 3, 2024

Continuing from #264 (comment).

In hope of expanding fmf beyond tmt context, I am proposing some restructuring of the documentation section to be more generic and easier to follow as a passer-by (what is this fmf thing about), basic-user (how do I write my first fmf tree), power-user (what's new in fmf, where's the reference guide), external developer (how do I work with fmf as a library), internal developer (python api, contribution guide).

One restructuring I am thinking of is having the following pages:

  • "What is fmf": a simple explanation of fmf as yaml + file structure with inheritance.
  • "Features": all the capabilities and definitions of fmf
  • "Advanced designs": suggestions for how to structure the fmf tree, advanced in-tree control parameters like /.inherit, advanced tree control parameters in .fmf/config, full list of operators (just because can't find a better place)
  • "Developer corner": what to expect from .fmf/version, how to expand fmf and more such topics

The concept page is too tmt specific and it's hard to parse outside of it. I think most of the content could be converted to a "what/why fmf".

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

1 participant