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

Documentation fix - TOML usage #1059

Closed
bscott opened this issue Jul 13, 2016 · 12 comments
Closed

Documentation fix - TOML usage #1059

bscott opened this issue Jul 13, 2016 · 12 comments
Assignees
Labels
Documentation Flags an issue / PR for attention by the technical documentation team
Milestone

Comments

@bscott
Copy link

bscott commented Jul 13, 2016

Documentation only shows how to use default.toml, not including user.toml

try!(cfg.load_default(pkg));
try!(cfg.load_user(pkg));
try!(cfg.load_gossip(pkg));
try!(cfg.load_environment(pkg));

@bookshelfdave
Copy link
Contributor

bookshelfdave commented Jul 13, 2016

environment.toml isn't a thing, this code loads environment variables. We're definitely missing docs on user.toml though.

Thanks!

@bscott
Copy link
Author

bscott commented Jul 13, 2016

@metadave thx I'll update issue, meant to just keep user in the desc.

@bscott
Copy link
Author

bscott commented Jul 14, 2016

@metadave Any preference where I can put the user.toml documentation in the docs?

@bookshelfdave
Copy link
Contributor

@bscott lets get @davidwrede's input on that

@bscott bscott self-assigned this Jul 14, 2016
@bookshelfdave
Copy link
Contributor

what are your thoughts on putting them somewhere under https://www.habitat.sh/docs/run-packages-overview/ ?

cc @davidwrede @juliandunn

@davidwrede
Copy link

@bscott, as @metadave suggested, under run-package-overview probably makes the most sense. We can always tweak and move it around later if needed.

@bscott
Copy link
Author

bscott commented Jul 15, 2016

@davidwrede Ok thanks

To clarify, user.toml is for user defined overrides of config settings.

@smith smith added the Backlog label Jul 20, 2016
@smurawski smurawski added this to the Help Wanted milestone Dec 6, 2016
@asymmetric
Copy link

@bscott any progress on your work documenting user.toml? :)

@rsertelon
Copy link
Contributor

Shouldn't it be in https://www.habitat.sh/docs/using-habitat/#config-updates now?

@tashimi
Copy link
Contributor

tashimi commented Dec 19, 2017

Yes, this looks good now. Thanks @rsertelon!

@tashimi tashimi closed this as completed Dec 19, 2017
@asymmetric
Copy link

@tashimi AFAICT there's still no mention of the user.toml on this page, isn't that what this issue was about?

@rsertelon
Copy link
Contributor

@asymmetric issue #3977 opened by @christophermaier is in the direction you suggest here IMHO.

@christophermaier christophermaier added Documentation Flags an issue / PR for attention by the technical documentation team and removed A-documentation labels Aug 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Flags an issue / PR for attention by the technical documentation team
Projects
None yet
Development

No branches or pull requests

10 participants