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

Move pkg/pillar/docs into top docs directory. #16

Open
eriknordmark opened this issue May 15, 2019 · 2 comments
Open

Move pkg/pillar/docs into top docs directory. #16

eriknordmark opened this issue May 15, 2019 · 2 comments
Labels
good first issue Good for newcomers

Comments

@eriknordmark
Copy link
Contributor

It is hard to find the docs down in pkg/pillar if you don't know they are there.

@rvs
Copy link
Contributor

rvs commented May 15, 2019

Agreed @eriknordmark -- I think all the new docs for sure should go under top level docs. There may be things like design docs, etc. that only make sense at the pillar level -- but we don't have those yet, I think.

@milan-zededa milan-zededa added the good first issue Good for newcomers label Feb 6, 2023
@rene
Copy link
Contributor

rene commented Apr 25, 2023

I think this is not an issue anymore. Pillar, as all other packages under pkg/, has its own documentation inside his own folder (which makes sense). Although it could be not easy to find such documentation in the past, currently we have mkdocs in place, which considers all documentation files throughout the whole repository. For example, pillar documentation can be easily accessed through mkdocs (when they are generated), or even more quick by accessing the online version at https://eve-os.readthedocs.io/en/latest/pkg/pillar/

My vote is to close this issue.

FYI: @eriknordmark , @rouming

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

No branches or pull requests

4 participants