k0s docs: add file-structure

Description

Fixes #951

describe the directory and file used by k0s

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation update

How Has This Been Tested?

[ ] Manual test
[ ] Auto test added

Checklist:

[x] My code follows the style guidelines of this project
[x] My commit messages are signed-off
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
[ ] I have checked my code and corrected any misspellings

Feb 22 '22 14:02 wenerme

@wenerme linter is not happy, check the Files Changed tab for its complaints.

Feb 23 '22 12:02 jnummelin

Thinking if it would be feasible to change all file/path references in k0s code to some kind of NamedPath objects that could be used to generate docs (or code would be generated from the doc) 🤔 This could help with windows compatibility too.

Feb 24 '22 08:02 kke

@kke windows support is experimental, may change later, and even use windows, there must have a controller+worker run in linux

A mapping of path to explain is good idea, but not easy to maintain

Feb 24 '22 08:02 wenerme

windows support is experimental, may change later, and even use windows, there must have a controller+worker run in linux

Yes, but we do have several FooFooDefaultWindows paths in the constants. This could be something like foo.RunDir.Default() and it would return the correct one depending on GOOS.

A mapping of path to explain is good idea, but not easy to maintain

Could be easier than maintaining separately in docs.

Feb 24 '22 08:02 kke

I haven't deploy k0s on windows before, I can update the doc after I have some experience about windows k0s deployment.

Feb 24 '22 08:02 wenerme

I am not convinced that a full listing of all files used by k0s, add meaningful information to the docs. Many of the listed files are auto-generated, and manipulating them will likely break k0s functionality if modified directly. A concise description of the directory structure, directory contents and its uses and important configuration file paths would be more useful, in my opinion.

Feb 28 '22 17:02 trawler

I am not convinced that a full listing of all files used by k0s, add meaningful information to the docs.

I'd love to agree. The thing with listing all the files in the docs is that:

it is now a contract to maintain that port of the documentation
a lot of those files are actually used internally