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.

Sign up for GitHub

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

Jump to bottom

Docs: Add explanation of package_dir=.terraform-serverless artifact directory default. #9

Open
2 tasks
ryan-roemer opened this issue Jan 17, 2020 · 0 comments
Open
2 tasks

Docs: Add explanation of package_dir=.terraform-serverless artifact directory default. #9

ryan-roemer opened this issue Jan 17, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ryan-roemer
Copy link
Member

It's likely that the vast bulk of folks familiar with serverless would assume I think that package_dir should default to .serverless, so we should explain why the default behavior won't work and you should choose our default or something that is not .serverless.

  • Explain in README why .serverless artifact directory won't work because of how this provider works with the serverless lifecycle.
  • Note in README we default to .terraform-serverless but users can configure package_dir for whatever they want.
@ryan-roemer ryan-roemer added the documentation Improvements or additions to documentation label Jan 17, 2020
@ryan-roemer ryan-roemer mentioned this issue Jan 17, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ryan-roemer