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

docs: use files directory instead of config directory #59

Open
notnotno opened this issue Jul 18, 2024 · 3 comments
Open

docs: use files directory instead of config directory #59

notnotno opened this issue Jul 18, 2024 · 3 comments

Comments

@notnotno
Copy link

The website documentation still mentions using the config/files directory, but the bluebuild client gives this warning: "WARN => Use of the ./config directory is deprecated. Please move your non-recipe files into ./files".

Also including clarification for the following would be helpful:

  • Is simply renaming 'config' directory to 'files' is all that's needed?
  • For the files module, would they be placed in files/files or just /files?
@fiftydinar
Copy link
Contributor

fiftydinar commented Jul 18, 2024

@notnotno

This change is not yet merged, but it will be very soon.
So only /tmp/config/ is still valid for now.

This log is something that is merged as a preparation for this in CLI, but it could have been blocked as a code comment, to avoid user's confusion.

Here's where you can track the status when this change is merged:
blue-build/modules#202
blue-build/modules#278
blue-build/template#36

We will make an announcement regarding this in the blog, so stay tuned.

@notnotno
Copy link
Author

@fiftydinar

Thanks. Also, not sure what needs to be merged exactly, but I did test simply renaming the 'config' directory to 'files' and it does work.

@fiftydinar
Copy link
Contributor

fiftydinar commented Jul 19, 2024

@notnotno It currently does mostly work, since the preliminary work is done in BlueBuild CLI regarding this.

Only gschema-overrides module won't work, which has hardcoded path to config/.

But we also changed files module to conform to this new files/ location, so it can use any location of choice in files/ instead of being hardcoded to files/files/ in your case.

This is covered in linked PR #278, which is waiting to be merged once documentation & announcement is ready.

It took some time until we fully investigated & decided on how this transition from config/ to files/ will finally look.

Hence why we didn't make docs about this yet.

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